Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_GetInitiatorLocalAuthParms (3IMA)

Name

IMA_GetInitiatorLocalAuthParms - Gets the parameters for the authentication method specified for a specified object ID

Synopsis

cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_GetInitiatorLocalAuthParms(
 /* in */      IMA_OID oid,
 /* in */      IMA_AUTHMETHOD method,
 /* out */     IMA_INITIATOR_AUTHPARMS *pParms,
 /* out */     IMA_BOOL *enabled
);

Parameters

oid

The object ID of the target, static target or discovery address whose authentication parameters are to be retrieved.

method

The authentication method of the object ID whose authentication parameters are to be retrieved.

pParms

A pointer to an IMA_INITIATOR_AUTHPARMS data structure. If successfully returned, this structure contains the initiator authentication parameters for the specified authentication method on the specified target.

enabled

A pointer to a boolean indicating whether use of the local initiator authentication parameters is enabled or disabled. If this argument is set to the value, IMA_TRUE, then the authentication parameters set for this object ID are used for initiator authentication.

Description

The IMA_GetInitiatorLocalAuthParms() API gets the parameters for the authentication method specified for a specified object ID to be used for one-way authentication.

Return Values

IMA_ERROR_INVALID_PARAMETER
  • Returned if the method argument does not specify a valid or a supported authentication method

  • Returned if the method argument has the value, IMA_AUTHMETHOD_NONE

  • Returned if the pParms argument is NULL, or specifies a memory area to which data cannot be written

IMA_ERROR_INVALID_OBJECT_TYPE

Returned if the oid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify a target

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a target known to the system

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/library/storage/snia-ima
Interface Stability
Volatile
MT-Level
Safe

See Also

libima(3LIB), attributes(7), IMA_SetInitiatorLocalAuthParms(3IMA)