Home    XP_CRYPT Online Help Prev Next
How To use XP_CRYPT GUI
Introduction
What is XP_CRYPT
System requirements
Free version limitations
End user license agreement
Installing XP_CRYPT
Installation procedure
Activation
XP_CRYPT API
What's new
Encryption methods overview
Session
xp_crypt_set_var
xp_crypt_get_var
xp_crypt_close_session
xp_crypt_init_session
xp_crypt_set_option
Asymmetric keys
DSA
xp_dsa_free_key
xp_dsa_load_key
xp_dsa_save_key
xp_dsa_generate_couple
RSA
xp_rsa_generate_couple
xp_rsa_generate_pub_key
xp_rsa_load_key
xp_rsa_priv_dec
xp_rsa_pub_enc
xp_rsa_save_key
xp_rsa_free_key
Digital signatures
DSA
xp_dsa_verify
xp_dsa_sign
RSA
xp_rsa_sign
xp_rsa_verify
Hashing
xp_crypt
xp_md5
xp_sha1
Symmetric encryption
AES128
xp_aes128_decrypt
xp_aes128_encrypt
AES
xp_aes_decrypt
xp_aes_encrypt
DESX
xp_desx_decrypt
xp_desx_encrypt
RC4
xp_rc4_decrypt
xp_rc4_encrypt
Triple DES
xp_des3_encrypt
xp_des3_decrypt
Error codes
Tutorial
How to use GUI
Advanced technique (Old)
Table encryption (Old)
Troubleshooting
Troubleshooting overview

xp_crypt_set_option

This function is used to change the parameters of your current session. 

Syntax

xp_crypt_set_option  { parameter_name, parameter_value }

Arguments

parameter_name

VARCHAR. Name of the parameter.

parameter_value

VARCHAR. Value of the parameter. Currently supported parameters:

Parameter name Accepted values
'use_crlf' 'yes' Default. Inserts a new line code into the base64 encoded output
'no' Does not insert a new line codes into the base64 encoded output
'pswd_cache' 'yes'  Provides password caching and loads private keys with specifying a password '?' . XP_CRYPT will use the password that was used last time with xp_rsa_load_key or xp_rsa_save_key. The session can store  passwords for different sources.
'no' Default. Does not permit caching passwords.
'timeout' Timeout in minutes as a VARCHAR value. The default value is 5 minutes
Return Code Values

0 - success, or Error code if failed.

Permissions

Execute permissions default to the public role.

Example

-- Initialize session
exec xp_crypt_init_session
-- Set timeout to 1 minute
exec xp_crypt_set_option 'timeout','1' 
exec xp_crypt_set_option 'use_crlf','no' 
....
-- Encrypt string and get the result without new line feeds 
exec xp_rsa_priv_dec @CryptedText, '<privatekey.pem', @name OUTPUT, @dateofbirth OUTPUT , @department OUTPUT, 'PassForThePrivateKey'
-- Close session
exec xp_crypt_close_session

 

 

Browser Based Help. Published by chm2web software.