List of usage examples

Session

Client session management with the HSM

• Connecting to HSM
• Using an access token

Users

HSM user management.

• Creating a user
• Removing a user
• Blocking a user
• Unlocking a user
• Changing the access password
• Listing access tokens
• Generating an access token
• Revoking an access token

Keys / Certificates

Cryptographic key lifecycle management within the HSM

• Creating a key
• Deleting a key
• Locking a key
• Unlocking a key
• Importing a symmetric key
• Importing a certificate
• Generating a P10
• Importing a PKCS#12
• Exporting asymmetric public keys
• Exporting an asymmetric private key
• Exporting a symmetric key
• Exporting certificates in plain text
• Importing a KEKed key
• Exporting a KEKed key
• Importing and exporting with PKCS#8

Cryptography

Symmetric and asymmetric cryptography hash operations

• Signing hashes with RSA
• Verifying hash signatures with RSA
• Signing hash with ECC
• Verifying hash signatures with ECC
• Signing hash with EdDSA
• Verifying hash signatures with EdDSA
• Dividing a secret into M from N
• Reconstructing a secret in M from N
• Generating a set of random bytes
• Signing a message with ML-DSA
• Verifying an ML-DSA signature
• Generating a hash (one-shot)
• Encryption/Decryption Using a Symmetric Key (One-Shot)
• Encrypting with a Symmetric Key Using Streams
• Generating Hashes Using Streams

Blockchain

Operations to support the security of Blockchain-based structures

• Creating a blockchain key
• Deleting a blockchain key
• Locking a blockchain key
• Unlocking a blockchain key
• Creating a derived bip32 blockchain key
• Importing a blockchain private key
• Exporting a blockchain private key
• Obtaining information from a blockchain key
• Generating data hash
• Signing hash with ECDSA blockchain key
• Verifying ECDSA blockchain signatures
• Signing hash with EdDSA blockchain key
• Verifying hash signatures with EdDSA blockchain
• Recovering a blockchain public key
• Recovering a public key from a signature
• Obtaining the blockchain address from the private key

Session Pool

HSM Session Pool Management for Concurrent Operations

• Connecting to the HSM Using a Session Pool
• Monitoring the Session Pool Status
• Closing Session Pools
• Automatically adjusting the pool's capacity

PIX

Signing, verification, and communication operations for the Central Bank’s instant payment arrangement (PIX/SPI/DICT)

• Signing and Verifying an SPI ( PIX ) Envelope
• Signing and verifying a " PIX " envelope from the Directory (DICT)
• Signing and Verifying a JWS PIX (RFC 7515)
• PIX mTLS HTTP requests (POST, PUT, GET, and DELETE)

Ocra

One Time Password (OTP) generation with OCRA function

• Creating a One Time Password (OTP) with OCRA function

Management

Managing the state of the M of N partition with smartcards.

• Recovering a smartcard shadow
• Changing the state of an M partition from N
• Retrieving information from a smartcard
• Recovering shadows and changing the state of a partition
• Recovering a smartcard label
• Generating a Server Master Key and Splitting it into parts with Shamir
• Recovering a split Server Master Key with Shamir
• Changing a user's permissions on an HSM partition (Trust relationship)
• Recovering a user's ACLs from an HSM partition
• Listing objects in an HSM partition
• Listing blobs in an HSM partition
• Listing an object's data in an HSM partition
• Listing data from an HSM partition object with ModprobeListInfo

Settings

Library settings

• Log configuration