PRIVATEKEYPASSWORD

Summary

The L_DicomSetClientCertificateTLS or L_DicomSetServerCertificateTLS functions generate a call to this function whenever the private key file is password encrypted in order to obtain the password to decrypt the file. When using this event function, copy the private key into the pszPassword buffer, and have the function return the length of the password. This function is available in the Medical Suite Toolkit.

Syntax

L_INT EXT_CALLBACK YourFunction (hNet, pszPassword, nSize, nFlag, pUserData)

Parameters

HDICOMNET hNet

A DICOM Network handle.

L_TCHAR * pszPassword

(in,out) pointer to a character string buffer to be used to hold the password. Copy the password for the private key file into this buffer.

L_INT nSize

(in) size of the buffer pointed to by pszPassword. This is an incoming parameter.

L_INT nFlag

(in) flag specifying whether pszPassword is being used for decryption or encryption. Possible values are:

L_VOID * pUserData

Void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function.

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

Have the function return the length of the password copied into the pszPassword buffer.

Comments

A call to this function may be generated after a call to L_DicomSetClientCertificateTLS or L_DicomSetClientCertificateTLS. Calling either of these functions with a private key file that is password encrypted will result in a call to this function in order to obtain the password. To process this function, perform the following steps:

1. Copy the password used to encrypt the private key into the pszPassword buffer.
2. Return the length of the password copied into pszPassword.

The nSize and nFlag arguments are provided for information, and should not be changed. The length of the pszPassword buffer is given in the nSize parameter. The input parameter nFlag indicates whether the password will be used for encryption or decryption.

To use this callback function, PRIVATEKEYPASSWORD must be set using L_DicomSetCallbackExt.

Required DLLs and Libraries

• LTDIC
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64

See Also

Functions

• L_DicomCreateNet
• L_DicomFreeNet
• L_DicomStartup
• L_DicomCreateNetExt
• L_DicomSetClientCertificateTLS
• L_DicomSetServerCertificateTLS
• L_DicomSetCallbackExt

Topics

• Working with DICOM Network Connections
• Adding TLS Security to a DICOM Connection
• DICOM Net: TLS Protocol

Example

For an example, refer to L_DicomCreateNetExt.