Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetInitiatorLocalAuthParms (3IMA)

Name

IMA_SetInitiatorLocalAuthParms - Sets the parameters for the authentication method specified for an object ID to be used for one-way authentication

Synopsis

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

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

Parameters

oid

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

method

The authentication method of the target whose authentication parameters are to be set.

pParms

A pointer to an IMA_INITIATOR_AUTHPARMS data structure that contains the parameters to be associated with the specified authentication method.

enabled

A boolean indicating whether use of the target specific initiator authentication parameters is enabled or disabled.

  • If this parameter is set to the value, IMA_TRUE the authentication parameters set for this object ID will be used for initiator authentication.

  • If this parameter is set to the value, IMA_FALSE, then the authentication parameters set for this object ID will not be used for initiator authentication.

Description

The IMA_SetInitiatorLocalAuthParms() API sets the parameters for the specified authentication method for the specified object ID to be used for one-way authentication.

Return Values

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of the authentication parameters takes effect

IMA_ERROR_INVALID_PARAMETER
  • Returned if the method argument does not specify a valid authentication method or does not specify 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 from which data cannot be read

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_GetInitiatorLocalAuthParms(3IMA)