IMA_GetSupportedAuthMethods - man pages section 3: Extended Library Functions, Volume 2

Language:

IMA_GetSupportedAuthMethods (3IMA)

Name

IMA_GetSupportedAuthMethods - Gets a list of the authentication methods supported by the specified LHBA

Synopsis

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

IMA_STATUS IMA_GetSupportedAuthMethods(
   /* in */      IMA_OID lhbaOid,
   /* in */      IMA_BOOL getSettableMethods,
   /* in, out */ IMA_UINT *pMethodCount,
   /* out */     IMA_AUTHMETHOD *pMethodList;
);

Parameters

lhbaOid

The object ID of a logical host bus adapter (LHBA) whose authentication methods are to be retrieved.

getSettableMethods

A boolean that indicates which set of authentication methods should be returned. If the value of this parameter is IMA_TRUE, then a list of authentication methods that are currently settable is returned. Settable authentication methods are those methods whose authentication parameters have been set.

If the value of this parameter is IMA_FALSE, then a list of all supported authentication methods is returned. This list may include authentication methods which cannot be set (enabled) until the authentication parameters of the methods are set.

pMethodCount

A pointer to an IMA_UINT data structure allocated by the caller. On entry, the value pointed to contains the maximum number of entries that can be placed into the pMethodList argument. On return, the value pointed to contains the number of entries that were actually placed into the pMethodList argument.

pMethodList

A pointer to an array of IMA_AUTHMETHOD data structures allocated by the caller.

If the value of this argument is not NULL, then on successful return, the array will be filled with the authentication methods supported by the LHBA. These entries are sorted in decreasing order of preference of the vendor of the LHBA.

If this value of this argument is NULL, then the value pointed to by the pMethodCount argument on entry is zero.

Description

The IMA_GetSupportedAuthMethods() API gets a list of the authentication methods supported by the specified LHBA.

Return Values

IMA_ERROR_INVALID_OBJECT_TYPE: Returned if the lhbaOid argument does not specify a valid object type
IMA_ERROR_INCORRECT_OBJECT_TYPE: Returned if the lhbaOid argument does not specify an LHBA
IMA_ERROR_OBJECT_NOT_FOUND: Returned if the lhbaOid argument does not specify an LHBA known to the system
IMA_ERROR_INVALID_PARAMETER: Returned if the pMethodList argument specifies a memory area to which data cannot be written

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

man pages section 3: Extended Library Functions, Volume 2