MSSQL User Defined Functions and APIs on

General Functions

Mon, 01 Jan 0001 00:00:00 +0000

pty_getVersion

This function returns the version of the installed protector.

Signature:

pty_getVersion()

Parameters:
None

Returns:
This UDF returns the version number as the NVARCHAR datatype.

Example:

DECLARE
@data NVARCHAR(64)
SELECT @data = <database_name>.dbo.pty_getVersion()
PRINT @data;

pty_whoAmI

This function returns the name of the logged in user.

Signature:

pty_whoAmI()

Parameters:
None

Returns:
This UDF returns the name of the user as the NVARCHAR datatype.

Example:

DECLARE
@data NVARCHAR
SELECT @data = <database_name>.dbo.pty_whoAmI()
PRINT @data

Insert Procedures

Mon, 01 Jan 0001 00:00:00 +0000

These extended procedures are used while protecting data using Insert queries.

xp_pty_insert

This stored procedure protects the data using an encryption data element.

Signature:

xp_pty_insert(outputdata VARBINARY OUTPUT, data VARCHAR,dataelement VARCHAR, scid INT)

Parameters:

Name	Type	Description
outputdata	VARBINARY(8000)	Specifies the result of the protect operation.
data	VARCHAR(8000)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.
scid	INT	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Returns:
This UDF returns either of the following values as protected data in the output parameter

UPDATE Extended Stored Procedures

Mon, 01 Jan 0001 00:00:00 +0000

These stored procedures are used while protecting data using Update statements.

xp_pty_update

This stored procedure protects the data using an encryption data element.

Signature:

xp_pty_update(outputdata VARBINARY OUTPUT, data VARCHAR, dataelement VARCHAR, status CHAR, scid INT)

Parameters:

Name	Type	Description
outputdata	VARBINARY(8000)	Specifies the result of the protect operation.
data	VARCHAR(8000)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.
status	CHAR(1)	Specifies the status value set to ‘T’.
scid	INT	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Returns:
This UDF returns either of the following values as protected data in the output parameter:

Access Check Procedures

Mon, 01 Jan 0001 00:00:00 +0000

These functions check access permissions allowed to the user for protecting or unprotecting the data. Depending on the permitted access, a bit value 0 (zero) or 1 is returned.

xp_pty_select_check

This stored procedure determines whether the user has select (unprotect) access to the data element.

Signature:

xp_pty_select_check(dataelement VARCHAR)

Parameters:

Name	Type	Description
dataelement	VARCHAR(64)	Specifies the name of the data element.

Returns:
This UDF returns either of the following values:

Select Functions and Procedures

Mon, 01 Jan 0001 00:00:00 +0000

These functions and stored procedures unprotect the data and return the unprotected value.

pty_select

This function unprotects the data that is protected by an encryption data element.

Signature:

pty_select (data VARBINARY, dataelement VARCHAR, def VARCHAR, scid INT)

Parameters:

Name	Type	Description
data	VARBINARY(8000)	Specifies the data to unprotect.
dataelement	VARCHAR(64)	Specifies the name of the the data element.
def	VARCHAR(8000)	Specifies the default value that is returned if user does not have the permission to unprotect.
scid	INT	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Returns:
This UDF returns the unprotected value as the VARCHAR(8000) datatype.

VARCHAR UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section provides a list of VARCHAR UDFs for both, protect and unprotect operations.

pty_varcharins

This UDF protects the VARCHAR data through Tokenization or the No Encryption method.

Signature:

pty_varcharins(data VARCHAR(8000), dataelement VARCHAR(64))

Parameters:

Name	Type	Description
data	VARCHAR(8000)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.

Results:
This UDF returns the protected value as the VARCHAR(8000) datatype.

Attention: If the user does not have access to the data in the policy, this UDF returns ‘NULL’.

NVARCHAR UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section provides a list of NVARCHAR UDFs for both, protect and unprotect operations.

pty_unicodevarcharins

This UDF protects the NVARCHAR data using the Unicode Gen2, and FPE data elements.

Note: This UDF does not support masking.

Signature:

pty_unicodevarcharins(data NVARCHAR(4000), dataelement VARCHAR(64))

Parameters:

Name	Type	Description
data	NVARCHAR(4000)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.

Returns:
This UDF returns the protected value as the NVARCHAR(4000) datatype.

Integer UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section provides a list of Integer UDFs for both, protect and unprotect operations.

pty_integerins

This UDF protects the Integer data through the tokenization method.

Signature:

pty_integerins(data Integer, dataelement VARCHAR(64))

Parameters:

Name	Type	Description
data	Integer	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.

Returns:
This UDF returns the protected value as the Integer datatype.

Attention: If the user does not have access to the data in the policy, this UDF returns ‘NULL’.

BLOB UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section provides a list of UDFs that can be used for both, encryption and decryption of the data stored as BLOB.

pty_blobenc

This function encrypts the data stored as VARBINARY(max) using any encryption data element.

Warning: This function supports encryption of data up to 1GB. However, exceeding this limit will result in memory issues.

Signature:

pty_blobenc(data VARBINARY(max), dataelement VARCHAR(64))

Parameters:

Name	Type	Description
data	VARBINARY (max*)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.

Returns:
This UDF returns the encrypted value as the VARBINARY (max*) datatype.

CLOB UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section provides a list of UDFs that can be used for both, encryption and decryption of the data stored in CLOB.

pty_clobenc

This function encrypts the data stored as VARCHAR(max*) using any encryption data element.

Warning: This function supports encryption of data up to 1GB. However, exceeding this limit will result in memory issues.

Signature:

pty_clobenc(data VARCHAR(max), dataelement VARCHAR(64))

Parameters:

Name	Type	Description
data	VARCHAR(max*)	Specifies the data to protect.
dataelement	VARCHAR(64)	Specifies the name of the data element.

Returns:
This UDF returns the encrypted value as the VARBINARY (max*) datatype.