AcquireAuthenticateInfo • AuthenticateKey • DestroyAuthenticateInfo • GenerateAuthenticateKey • GetAuthenticateId • GetAuthenticateKey • GetAuthenticateKeyLength • GetAuthenticatePassphrase • SetAuthenticateId • SetAuthenticateKeyLength • SetAuthenticatePassphrase

AcquireAuthenticateInfo

AcquireAuthenticateInfo() allocates the AuthenticateInfo structure.

The format of the AcquireAuthenticateInfo method is:

AuthenticateInfo *AcquireAuthenticateInfo(
  const AuthenticateMethod method,const char *path,const HashType hash)

A description of each parameter follows:

authenticate

The authenticate type.

path

The keyring path.

hash

The hash type.

AuthenticateKey

AuthenticateKey() returns WizardTrue if the caller is authenticated.

The format of the AuthenticateKey method is:

void AuthenticateKey(AuthenticateInfo *authenticate_info,
  ExceptionInfo *exception)

A description of each parameter follows:

authenticate_info

The authenticate info.

exception

Return any errors or warnings in this structure.

DestroyAuthenticateInfo

DestroyAuthenticateInfo() zeros memory associated with the AuthenticateInfo structure.

The format of the DestroyAuthenticateInfo method is:

AuthenticateInfo *DestroyAuthenticateInfo(
  AuthenticateInfo *authenticate_info)

A description of each parameter follows:

authenticate_info

The authenticate info.

GenerateAuthenticateKey

GenerateAuthenticateKey() returns WizardTrue if a secret key is generated and successfully added to the secret key ring.

The format of the GenerateAuthenticateKey method is:

WizardBooleanType GenerateAuthenticateKey(
  AuthenticateInfo *authenticate_info,ExceptionInfo *exception)

A description of each parameter follows:

authenticate_info

The authenticate info.

exception

Return any errors or warnings in this structure.

GetAuthenticateId

GetAuthenticateId() returns the authentication id.

The format of the GetAuthenticateId method is:

const StringInfo *GetAuthenticateId(
  const AuthenticateInfo *authenticate_info)

A description of each parameter follows:

authenticate_info

The authenticate info.

GetAuthenticateKey

GetAuthenticateKey() returns the authenticate key.

The format of the GetAuthenticateKey method is:

const StringInfo *GetAuthenticateKey(
  const AuthenticateInfo *authenticate_info)

A description of each parameter follows:

authenticate_info

The authenticate info.

GetAuthenticateKeyLength

GetAuthenticateKeyLength() returns the authenticate key length.

The format of the GetAuthenticateKeyLength method is:

size_t GetAuthenticateKeyLength(
  const AuthenticateInfo *authenticate_info)

A description of each parameter follows:

authenticate_info

The authenticate info.

GetAuthenticatePassphrase

GetAuthenticatePassphrase() returns the authentication passphrase.

The format of the GetAuthenticatePassphrase method is:

const char *GetAuthenticatePassphrase(
  const AuthenticateInfo *authenticate_info)

A description of each parameter follows:

authenticate_info

The authenticate info.

SetAuthenticateId

SetAuthenticateId() sets the authentication id.

The format of the SetAuthenticateId method is:

void SetAuthenticateId(AuthenticateInfo *authenticate_info,
  const StringInfo *id)

A description of each parameter follows:

authenticate_info

The authentication info.

id

The id.

SetAuthenticateKeyLength

SetAuthenticateKeyLength() sets the authentication method key length.

The format of the SetAuthenticateKeyLength method is:

void SetAuthenticateKeyLength(AuthenticateInfo *authenticate_info,
  const size_t key_length)

A description of each parameter follows:

authenticate_info

The authenticate info.

key_length

The key length in bits.

SetAuthenticatePassphrase

SetAuthenticatePassphrase() sets the authentication method key file.

The format of the SetAuthenticatePassphrase method is:

void SetAuthenticatePassphrase(AuthenticateInfo *authenticate_info,
  const char *passphrase)

A description of each parameter follows:

authenticate_info

The authenticate info.

passphrase

The passphrase.