tpm2_geteccparameters(1)

📦
version 5.8 · 10 versions
, in arch rolling

💅 tpm2_geteccparameters(1) — like, the General Commands Manual, bestie 🎀

okay so real talk: this is a page from tpm2-tools, and it's literally the manual for tpm2_geteccparameters(1). Buckle up, she's a long one but we're gonna get through it together 🫶

✨ NAME ✨

tpm2_geteccparameters(1) — grabs the parameters of an ECC curve, and the curve is identified by its TCG-assigned curveID. that's it, that's the whole vibe 💫

✨ SYNOPSIS ✨

tpm2_geteccparameters [OPTIONS]

✨ DESCRIPTION ✨

tpm2_geteccparameters(1) — Retrieves the parameters of an ECC curve identified by its TCG-assigned curveID. yes she's repeating herself, but honestly? iconic. no cap, that's the entire job 📋

✨ OPTIONS ✨

  • ARGUMENT=ALGORITHM — specify which ECC curve you want, bestie. example: ecc521 🌸
  • -o, --output=FILE — tell her where to save the ECC parameters (the file path, specifically) 💾
  • --cphash=FILE — file path where the hash of the command parameters gets recorded. people usually call this the cpHash. ⚠️ big important NOTE: when you pick this option, the tool will not actually execute the command — it just hands you a cpHash and that's it. so don't come crying that nothing happened 😭

📚 References

🔮 Algorithm Specifiers

options that take algorithms support “nice-names”. cute, right?

there are two major algorithm specification string classes: simple and complex. and heads up — only certain algorithms will be accepted by the TPM, based on usage and conditions. the TPM is picky like that 🙈

🌼 Simple specifiers

these are strings with no additional specification data. when you're creating objects, any non-specified portions of an object are assumed to be defaults. the list of known “Simple Specifiers” is right below 👇

🦋 Asymmetric

  • rsa
  • ecc

🍓 Symmetric

  • aes
  • camellia
  • sm4

💜 Hashing Algorithms

  • sha1
  • sha256
  • sha384
  • sha512
  • sm3_256
  • sha3_256
  • sha3_384
  • sha3_512

🎀 Keyed Hash

  • hmac
  • xor

✨ Signing Schemes

  • rsassa
  • rsapss
  • ecdsa
  • ecdaa
  • ecschnorr
  • sm2

🌈 Asymmetric Encryption Schemes

  • oaep
  • rsaes
  • ecdh

🧚 Modes

  • ctr
  • ofb
  • cbc
  • cfb
  • ecb

⭐ Misc

  • null

🌸 Complex Specifiers

when objects get specified for creation by the TPM, they've got numerous algorithms to populate in the public data. stuff like type, scheme and asymmetric details, key size, etc. the general format for specifying this data is:

<type>:<scheme>:<symmetric-details>

👑 Type Specifiers

this portion of the complex algorithm specifier is required. the remaining scheme and symmetric details will default based on the type specified and the type of the object being created. no skipping this one, bestie 🚨

  • aes — Default AES: aes128
  • aes128<mode> — 128 bit AES with optional mode (ctr|ofb|cbc|cfb|ecb). if mode is not specified, it defaults to null.
  • aes192<mode> — same as aes128<mode>, except for a 192 bit key size.
  • aes256<mode> — same as aes128<mode>, except for a 256 bit key size.
  • sm4 — Default SM4: sm4128
  • sm4128 or sm4_128 <mode> — 128 bit SM4 with optional mode (ctr|ofb|cbc|cfb|ecb). if mode is not specified, it defaults to null.
  • ecc — Elliptical Curve, defaults to ecc256.
  • ecc192 or ecc_nist_p192 — 192 bit ECC NIST curve
  • ecc224 or ecc_nist_p224 — 224 bit ECC NIST curve
  • ecc256 or ecc_nist_p256 — 256 bit ECC NIST curve
  • ecc384 or ecc_nist_p384 — 384 bit ECC NIST curve
  • ecc521 or ecc_nist_p521 — 521 bit ECC NIST curve
  • ecc_sm2 or ecc_sm2_p256 — 256 bit SM2 curve
  • rsa — Default RSA: rsa2048
  • rsa1024 — RSA with 1024 bit keysize.
  • rsa2048 — RSA with 2048 bit keysize.
  • rsa3072 — RSA with 3072 bit keysize.
  • rsa4096 — RSA with 4096 bit keysize.

💫 Scheme Specifiers

next up is an optional field — you can literally just skip it, no pressure 🫶

schemes are usually Signing Schemes or Asymmetric Encryption Schemes. most signing schemes take a hash algorithm directly following the signing scheme. if the hash algorithm is missing, it defaults to sha256. some take no arguments, and some take multiple arguments. chaotic, i know.

🧁 Hash Optional Scheme Specifiers

these scheme specifiers are followed by a dash and a valid hash algorithm. for example: oaep-sha256.

  • oaep
  • ecdh
  • rsassa
  • rsapss
  • ecdsa
  • ecschnorr
  • sm2

🍰 Multiple Option Scheme Specifiers

this scheme specifier is followed by a count (max size UINT16) then followed by a dash (-) and a valid hash algorithm. * ecdaa for example, ecdaa4-sha256. if no count is specified, it defaults to 4.

🎯 No Option Scheme Specifiers

this scheme specifier takes NO arguments. * rsaes

🦢 Symmetric Details Specifiers

this field is optional, and defaults based on the type of object being created and it's attributes. generally, any valid Symmetric specifier from the Type Specifiers list should work. if not specified, an asymmetric object's symmetric details defaults to aes128cfb. slay 💅

🌟 Examples

create an rsa2048 key with an rsaes asymmetric encryption scheme

tpm2_create -C parent.ctx -G rsa2048:rsaes -u key.pub -r key.priv

create an ecc256 key with an ecdaa signing scheme with a count of 4 and sha384 hash

/tpm2_create -C parent.ctx -G ecc256:ecdaa4-sha384 -u key.pub -r key.priv cryptographic algorithms ALGORITHM.

💖 COMMON OPTIONS 💖

this collection of options are common to many programs and provide information that many users may expect. the friend group of options, if you will 👯‍♀️

  • -h, --help=[man|no-man] — Display the tool's manpage. by default, it attempts to invoke the manpager for the tool, however, on failure it will output a short tool summary. this is the same behavior if the “man” option argument is specified, however if explicit “man” is requested, the tool will provide errors from man on stderr. if the “no-man” option is specified, or the manpager fails, the short options will be output to stdout.
to successfully use the manpages feature you need the manpages installed or on MANPATH. see man(1) for more details. iykyk 📖
  • -v, --version — Display version information for this tool, supported tctis and exit. 👋
  • -V, --verbose — Increase the information that the tool prints to the console during its execution. when using this option the file and line number are printed. she's chatty and we love her 🗣️
  • -Q, --quiet — Silence normal tool output to stdout. 🤫
  • -Z, --enable-errata — Enable the application of errata fixups. useful if an errata fixup needs to be applied to commands sent to the TPM. defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. 🔧
  • -z, --pwd-session — Use password session instead of a HMAC session for authentication. a clear text password is passed to the TPM to authorize the action. this option can be used to avoid problems when unsalted sessions are used in OpenSSL FIPS mode. if auth values are used a salted session should be used for authentication. 🔐
  • -R, --autoflush — Enable autoflush for transient objects created by the command. if a parent object is loaded from a context file also the transient parent object will be flushed. autoflush can also be activated if the environment variable TPM2TOOLS_AUTOFLUSH is is set to yes or true. 🚽✨

information many users may expect.

📡 TCTI Configuration

the TCTI or “Transmission Interface” is the communication mechanism with the TPM. TCTIs can be changed for communication with TPMs across different mediums. she's the group chat bridge between you and the TPM 💬

to control the TCTI, the tools respect:

  1. the command line option -T or --tcti
  2. the environment variable: TPM2TOOLS_TCTI.
Note: the command line option always overrides the environment variable. no arguing 🫵

the current known TCTIs are:

  • tabrmd — the resource manager, called tabrmd. note that tabrmd and abrmd as a tcti name are synonymous. two names, one queen 👑
  • mssim — typically used for communicating to the TPM software simulator.
  • device — used when talking directly to a TPM device file.
  • none — do not initalize a connection with the TPM. some tools allow for off-tpm options and thus support not using a TCTI. tools that do not support it will error when attempted to be used without a TCTI connection. does not support ANY options and MUST BE presented as the exact text of “none”. she's strict like that 🚫

the arguments to either the command line option or the environment variable are in the form:

<tcti-name>:<tcti-option-config>

specifying an empty string for either the <tcti-name> or <tcti-option-config> results in the default being used for that portion respectively. 🫧

🌙 TCTI Defaults

when a TCTI is not specified, the default TCTI is searched for using dlopen(3) semantics. the tools will search for tabrmd, device and mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. you can query what TCTI will be chosen as the default by using the -v option to print the version information. the “default-tcti” key-value pair will indicate which of the aforementioned TCTIs is the default. first come, first served fr fr 🏁

🧚 Custom TCTIs

any TCTI that implements the dynamic TCTI interface can be loaded. the tools internally use dlopen(3), and the raw tcti-name value is used for the lookup. thus, this could be a path to the shared library, or a library name as understood by dlopen(3) semantics. bring your own, bestie 🎁

🔌 TCTI OPTIONS

this collection of options are used to configure the various known TCTI modules available:

  • device — for the device TCTI, the TPM character device file for use by the device TCTI can be specified. the default is /dev/tpm0.

example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“device:/dev/tpm0”

  • mssim — for the mssim TCTI, the domain name or IP address and port number used by the simulator can be specified. the defaults are 127.0.0.1 and 2321.

example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TCTI=“mssim:host=localhost,port=2321”

  • abrmd — for the abrmd TCTI, the configuration string format is a series of simple key value pairs separated by a , character. each key and value string are separated by a = character.

TCTI abrmd supports two keys:

  1. bus_name : the name of the tabrmd service on the bus (a string).
  2. bus_type : the type of the dbus instance (a string) limited to session and system.

specify the tabrmd tcti name and a config string of bus_name=com.example.FooBar:

\--tcti=tabrmd:bus_name=com.example.FooBar

specify the default (abrmd) tcti and a config string of bus_type=session:

\--tcti:bus_type=session
NOTE: abrmd and tabrmd are synonymous. the various known TCTI modules. 🫶

🌈 EXAMPLES 🌈

tpm2_geteccparameters ecc256 -o ecc.params

look at her go 😭💖

🎀 Returns

tools can return any of the following codes:

  • 0 — Success. 🎉
  • 1 — General non-specific error. 💀
  • 2 — Options handling error. 🙃
  • 3 — Authentication error. 🔒
  • 4 — TCTI related error. 📡
  • 5 — Non supported scheme. applicable to tpm2_testparams.

🐛 BUGS

Github Issues — yes, that's where you go. go tell 'em 🫡

🆘 HELP

See the Mailing List 📬

⚖️ License

this work is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0). 📜

and that's the whole page, bestie 🎀✨ this has been tpm2_geteccparameters(1) from the tpm2-tools package — mwah, go touch some ECC curves 💅🦋

📦 where this page comes from