Interface Management

interface Management {
getShadow(pin: string): Promise<string>;
setNsAuthState(aclMask: ACL_MASK, state: NSAUTH_STATE, share: string[]): Promise<boolean>;
}

Index

Methods

getShadow setNsAuthState

Methods

getShadow

getShadow(pin): Promise<string>
Reads the shadow of a smart card M from N Dinamo.
Parameters
- pin: string
  Card PIN. It must be an ASCII numeric string with a maximum length of 8.
Returns Promise<string>
- Shadow read data.
Throws
exceptions.HsmError If an error occurs in the operation.

Remarks
NOTE: To carry out this operation, you need to install the HSM Client in the Full option on the device. You can download the HSM Client via this link. You must also use an approved smartcard reader to read the cards.

See
Example code: Recovering the shadow of a smartcard

setNsAuthState

setNsAuthState(aclMask, state, share): Promise<boolean>
Configures the authentication status of the NS (Network Security) system.
Parameters
- aclMask: ACL_MASK
  Access control mask(ACL_MASK). It can be a combination of allowed values (e.g. ACL_MASK . OBJ_READ | ACL_MASK.USR_CREATE | ACL_MASK.SYS_OPERATOR) using bitwise operations.
- state: NSAUTH_STATE
  NS authentication state (STATE). Must be one of the values in the NSAUTH_STATE enum.
- share: string[]
  Array of hexadecimal strings representing the shares M of N. Each share must be a hexadecimal string.
Returns Promise<boolean>
- It resolves if the configuration is successful.
Throws
exceptions.HsmError If an error occurs in the operation or if a parameter is invalid.

See
- Example code: Changing the state of an M partition from N
- Example code: Recovering shadows and changing the state of a partition

Interface Management

Index

Methods

Methods

getShadow

Parameters

Returns Promise<string>

Throws

Remarks

See

setNsAuthState

Parameters

Returns Promise<boolean>

Throws

See

Settings

On This Page