Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetMutualLocalAuthParms (3IMA)

Name

IMA_SetMutualLocalAuthParms - Sets the parameters for the authentication method specified for an object ID to be used for mutual authentication

Synopsis

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

IMA_STATUS IMA_SetMutualAuthParms(
    /* in */     IMA_OID oid,
    /* in */     IMA_AUTHMETHOD method,
    /* in */     const IMA_TARGET_AUTHPARMS *pParms,
    /* in */     IMA_BOOL mutualAuthEnabled
);

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 object ID whose authentication parameters are to be set.

pParms

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

mutualAuthEnabled

A boolean indicating whether mutual authentication will be performed for the specified object ID for the specified authentication method.

  • If this parameter is set to the value, IMA_TRUE, then the initiator will perform mutual authentication for the specified object ID for the specified authentication method.

  • If this parameter is set to the value, IMA_FALSE, then the initiator will not perform the mutual authentication.

Description

The IMA_SetMutualLocalAuthParms() API sets the parameters for the authentication method specified for an object ID to be used for mutual 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 or 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, static target or discovery address

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify an object ID 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_GetMutualLocalAuthParms(3IMA), IMA_GetMutualLocalAuth(3IMA), IMA_SetMutualLocalAuth(3IMA)