AcquireSecretInfo • AuthenticateSecretKey • DestroySecretInfo • GenerateSecretKey • GetSecretId • GetSecretKey • GetSecretKeyLength • GetSecretPassphrase • SetSecretId • SetSecretKeyLength • SetSecretPassphrase
AcquireSecretInfo
AcquireSecretInfo() allocates the SecretInfo structure.
The format of the AcquireSecretInfo method is:
SecretInfo *AcquireSecretInfo(const char *path,const HashType hash, const size_t key_length)
A description of each parameter follows:
- path
- The secret keyring path.
- hash
- The hash type.
- key_length
- The key length in bits.
AuthenticateSecretKey
AuthenticateSecretKey() returns WizardTrue if the caller is authenticated.
The format of the AuthenticateSecretKey method is:
void AuthenticateSecretKey(SecretInfo *secret_info, ExceptionInfo *exception)
A description of each parameter follows:
- secret_info
- The secret info.
- exception
- Return any errors or warnings in this structure.
DestroySecretInfo
DestroySecretInfo() zeros memory associated with the SecretInfo structure.
The format of the DestroySecretInfo method is:
SecretInfo *DestroySecretInfo(SecretInfo *secret_info)
A description of each parameter follows:
- secret_info
- The secret info.
GenerateSecretKey
GenerateSecretKey() returns WizardTrue if a key is generated and successfully added to the secret key ring.
The format of the GenerateSecretKey method is:
WizardBooleanType GenerateSecretKey(SecretInfo *secret_info, ExceptionInfo *exception)
A description of each parameter follows:
- secret_info
- The secret info.
- exception
- Return any errors or warnings in this structure.
GetSecretId
GetSecretId() returns the secret id.
The format of the GetSecretId method is:
const StringInfo *GetSecretId(const SecretInfo *secret_info)
A description of each parameter follows:
- secret_info
- The secret info.
GetSecretKey
GetSecretKey() returns the secret key.
The format of the GetSecretKey method is:
const StringInfo *GetSecretKey(const SecretInfo *secret_info)
A description of each parameter follows:
- secret_info
- The secret info.
GetSecretKeyLength
GetSecretKeyLength() returns the secret key length.
The format of the GetSecretKeyLength method is:
size_t GetSecretKeyLength(const SecretInfo *secret_info)
A description of each parameter follows:
- secret_info
- The secret info.
GetSecretPassphrase
GetSecretPassphrase() returns the secret passphrase.
The format of the GetSecretPassphrase method is:
const char *GetSecretPassphrase(const SecretInfo *secret_info)
A description of each parameter follows:
- secret_info
- The secret info.
SetSecretId
SetSecretId() sets the secret id.
The format of the SetSecretId method is:
void SetSecretId(SecretInfo *secret_info,const StringInfo *id)
A description of each parameter follows:
- secret_info
- The ring info.
- id
- The id.
SetSecretKeyLength
SetSecretKeyLength() sets the authentication method key length.
The format of the SetSecretKeyLength method is:
void SetSecretKeyLength(SecretInfo *secret_info, const size_t key_length)
A description of each parameter follows:
- secret_info
- The secret info.
- key_length
- The key length in bits.
SetSecretPassphrase
SetSecretPassphrase() sets the secret passphrase.
The format of the SetSecretPassphrase method is:
void SetSecretPassphrase(SecretInfo *secret_info,const char *passphrase)
A description of each parameter follows:
- secret_info
- The secret info.
- passphrase
- The passphrase.