Module yubihsm::commands[][src]

Commands supported by the YubiHSM2

Functions defined in the yubihsm::commands module are reimported and available from the toplevel yubihsm module as well.

For more information, see: https://developers.yubico.com/YubiHSM2/Commands/

Modules

attest_asymmetric

Obtain an X.509 attestation certificate for a key within the YubiHSM2

blink

Blink the LED on the YubiHSM2 for the given number of seconds

delete_object

Delete an object of the given ID and type

device_info

Get information about the YubiHSM2 device

echo

Have the card echo an input message

export_wrapped

Export an encrypted object from the YubiHSM2 using the given key-wrapping key

generate_asymmetric_key

Generate a new asymmetric key within the YubiHSM2

generate_hmac_key

Generate a new HMAC key within the YubiHSM2

generate_key

Generate keys within the YubiHSM2

generate_wrap_key

Generate a wrapping (i.e. encryption) key within the YubiHSM2

get_logs

Get audit logs from the YubiHSM2 device

get_object_info

Get information about an object

get_opaque

Get the public key for an asymmetric key stored on the device

get_pseudo_random

Get Pseudo Random Bytes

get_pubkey

Get the public key for an asymmetric key stored on the device

hmac

Compute HMAC tag for the given input data

import_wrapped

Import an encrypted object from the YubiHSM2 using the given key-wrapping key

list_objects

List objects visible from the current session

put_asymmetric_key

Put an existing asymmetric key into the YubiHSM2

put_auth_key

Put an existing auth key into the YubiHSM2

put_hmac_key

Put an existing HMAC key into the YubiHSM2

put_opaque

Put an opaque object into the YubiHSM2

put_otp_aead_key

Put an existing OTP AEAD key into the YubiHSM2

put_wrap_key

Put an existing wrap key into the YubiHSM2

reset

Reset the device: clear all stored objects, restore the default auth key, and reboot

set_log_index

Set the index of the last consumed index of the YubiHSM2 audit log

sign_ecdsa

Compute an ECDSA signature of the SHA-256 hash of the given data with the given key ID

sign_eddsa

Compute an Ed25519 signature with the given key ID

sign_rsa_pkcs1v15

Compute an RSASSA-PKCS#1v1.5 signature of the SHA-256 hash of the given data

sign_rsa_pss

Compute an RSASSA-PSS signature of the SHA-256 hash of the given data

storage_status

Get storage status (i.e. currently free storage) from the YubiHSM2 device

unwrap_data

Decrypt data which was encrypted (using AES-CCM) under a wrap key

verify_hmac

Verify HMAC tag for the given input data

wrap_data

Encrypt data (with AES-CCM) using the given wrap key

Enums

CommandType

Command IDs for YubiHSM2 operations