---
name: "nethsm-key-import"
section: "1"
platform: "linux"
package: "nethsm-cli"
version: "0.10.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/nethsm-key-import"
---

# nethsm-key-import(1)

The "nethsm key import" command

## NAME

nethsm-key-import - The "nethsm key import" command

## SYNOPSIS

**nethsm key import** \[**-a**\|**--auth-passphrase-file**\] \[**--format**\] \[**-c**\|**--config**\] \[**-k**\|**--key-id**\] \[**-t**\|**--tags**\] \[**-l**\|**--label**\] \[**-u**\|**--user**\] \[**-h**\|**--help**\] \<*KEY\_TYPE*\> \<*KEY\_DATA*\> \[*KEY\_MECHANISMS*\]

## DESCRIPTION

The "nethsm key import" command

## OPTIONS

- **-a**, **--auth-passphrase-file** *\<AUTH\_PASSPHRASE\_FILE\>*

  The path to a file containing a passphrase for authentication

  The passphrase provided in the file must be the one for the user chosen for the command.

  This option can be provided multiple times, which is needed for commands that require multiple roles at once. With multiple passphrase files ordering matters, as the files are assigned to the respective user provided by the "--user" option.

  May also be specified with the **NETHSM\_AUTH\_PASSPHRASE\_FILE** environment variable.

- **--format** *\<FORMAT\>* \[default: Der\]

  The format of key to import

  Keys can be imported in Distinguished Encoding Rules (DER) or Privacy-Enhanced Mail (PEM) format.

  One of \["Pem", "Der"\].

  May also be specified with the **NETHSM\_KEY\_FORMAT** environment variable.

- **-c**, **--config** *\<CONFIG\>*

  The path to a custom configuration file

  If specified, the custom configuration file is used instead of the default configuration file location.

  May also be specified with the **NETHSM\_CONFIG** environment variable.

- **-k**, **--key-id** *\<KEY\_ID\>*

  An optional unique ID that is assigned to the imported key

  If none is provided a generic one is generated for the key.

  May also be specified with the **NETHSM\_KEY\_ID** environment variable.

- **-t**, **--tags** *\<TAGS\>*

  An optional list of tags that are assigned to the imported key

  Tags on keys are used to grant access to those keys for users that carry the same tags.

  May also be specified with the **NETHSM\_KEY\_TAGS** environment variable.

- **-l**, **--label** *\<LABEL\>*

  An optional label that is assigned to the imported key

  Labels can be used to filter keys in the list of all keys.

  May also be specified with the **NETHSM\_KEY\_LABEL** environment variable.

- **-u**, **--user** *\<USER\>*

  A user name which is used for a command

  Can be provided, if no user name is setup in the configuration file for a device. Must be provided, if several user names of the same target role are setup in the configuration file for a device.

  This option can be provided multiple times, which is needed for commands that require multiple roles at once.

  May also be specified with the **NETHSM\_USER** environment variable.

- **-h**, **--help**

  Print help (see a summary with '-h')

- \<*KEY\_TYPE*\>

  The type of key to import

  The key type must match the provided key data and chosen key mechanisms!

  One of \["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"\].

  May also be specified with the **NETHSM\_KEY\_TYPE** environment variable.

- \<*KEY\_DATA*\>

  The path to a PKCS#8 private key in ASN.1 DER-encoded format

  The private key data must match the chosen key type.

  May also be specified with the **NETHSM\_KEY\_DATA** environment variable.

- \[*KEY\_MECHANISMS*\]

  The mechanisms provided by the imported key

  The key mechanisms must match the chosen key type!

  At least one of \["AesDecryptionCbc", "AesEncryptionCbc", "EcdsaSignature", "EdDsaSignature", "RsaDecryptionOaepMd5", "RsaDecryptionOaepSha1", "RsaDecryptionOaepSha224", "RsaDecryptionOaepSha256", "RsaDecryptionOaepSha384", "RsaDecryptionOaepSha512", "RsaDecryptionPkcs1", "RsaDecryptionRaw", "RsaSignaturePkcs1", "RsaSignaturePssSha1", "RsaSignaturePssSha224", "RsaSignaturePssSha256", "RsaSignaturePssSha384", "RsaSignaturePssSha512"\].

  May also be specified with the **NETHSM\_KEY\_MECHANISMS** environment variable.