The Shared Secret functions are built on top of the raw SecretStore functions, so they inherently comply with the SecretStore specifications (see Shared Secret Format). Connectors use these functions to create Shared Secret (SHS) compliant secret IDs and secrets.
This section discusses the following specifications for Shared Secret functions:
The Shared Secret operational functions operate on SecretStore and require that you set up the context to the SecretStore using regular SecretStore functions before using these function. These calls use SecretIDs that comply with SHS format (see Shared Secret Format):
Function |
Description |
---|---|
Enables a secret in the SHS format to be read out of the SecretStore and assigned to a handle previously created with a Create Handle call to be used by these calls. |
|
Enables a secret in the SHS format that is previously assigned to a handle to be written to the SecretStore. |
|
Enables a secret in the SHS format to be removed from the SecretStore. The SecretID is assigned to a previously initialized handle. These operational APIs are created and formed using the Processing APIs listed below. |
Here are the processing functions that operate on the secret buffers returned by the Shared Secret Operational functions:
NOTE:As explained in Section 1.6.2, Shared Secret Format, Shared Secret components are on key/value paired structures formed as a list that are used by the processing functions. Operational functions can consume SHS buffers (list of components) signified by a handle and convert them to and from raw secret format for raw read and write operations to and from SecretStore.
To help you implement the Shared Secret functions, you should understand the sequence of events when reading, writing, and removing a shared Application or Credential Set secret. Follow the procedures outlined in the following sections:
Keep in mind the following points about the connector:
As with the SecretStore raw APIs, a complete collection of Shared Secret sample code is available on Novell's Developer Web site as a component of the Novell NDK. The following sample code can be downloaded and used as template that completely demonstrates the use of SecretStore APIs:
All of the API prototypes, flags, structures, and error codes are defined in the ssshs.h file.