|
security.encrypt-string
|
| |
|
description
Performs encryption on some text.
privilege-required
anyone
tx-support
false
|
| |
|
INSTRUCTION
|
|
name
|
type
|
default-value
|
required
|
description
|
| alias |
string |
none |
true |
The alias of the key that will be used for encryption. |
| store |
string |
none |
true |
The name of the store the keys will be stored in. Depends on the server configuration. |
|
| |
|
PARAMETER
|
|
name
|
type
|
default-value
|
required
|
description
|
| data |
string |
none |
true |
The text that will be encrypted. |
|
| |
|
ERROR
|
|
|
id
|
msg
|
| 1 |
Store does not exist. |
| 2 |
Alias doesn't exist in this store. |
|
| |
|
RESULT
|
|
|
name
|
description
|
| encrypted-data |
The encrypted data, subsequently encoded as base 64. |
|
| |
|
EXAMPLE
|
|
|
example 1
|
<nvd:command name="security.encrypt-string" alias="privateKeyAlias" store="thestore">
<nvd:parameter name="data">some text to be encoded</nvd:parameter>
<nvd:result name="encrypted-data" variable="myVar"/>
</nvd:command>
|
|
