diff --git a/card-functionality/README.md b/card-functionality/README.md index 9f89c18..11c70ec 100644 --- a/card-functionality/README.md +++ b/card-functionality/README.md @@ -45,12 +45,12 @@ behavior. ## Example for card-specific behavior that contradicts the spec -Yubikey 5 fails to handle the VERIFY command with empty data +YubiKey 5 fails to handle the VERIFY command with empty data (see OpenPGP card spec, 7.2.2: "If the command is called without data, the actual access status of the addressed password is returned or the access status is set to 'not verified'"). -The Yubikey 5 erroneously returns Status 0x6a80 ("Incorrect parameters in +The YubiKey 5 erroneously returns Status 0x6a80 ("Incorrect parameters in the command data field"). diff --git a/openpgp-card/src/card_do/algo_info.rs b/openpgp-card/src/card_do/algo_info.rs index 0f0a2c0..5d5539b 100644 --- a/openpgp-card/src/card_do/algo_info.rs +++ b/openpgp-card/src/card_do/algo_info.rs @@ -74,7 +74,7 @@ fn parse_tl_list(input: &[u8]) -> nom::IResult<&[u8], Vec<(KeyType, Algo)>> { pub(self) fn parse(input: &[u8]) -> nom::IResult<&[u8], Vec<(KeyType, Algo)>> { // Handle two variations of input format: - // a) TLV format (e.g. Yubikey 5) + // a) TLV format (e.g. YubiKey 5) // b) Plain list (e.g. Gnuk, FOSS-Store Smartcard 3.4) // -- Gnuk: do_alg_info (uint16_t tag, int with_tag) diff --git a/openpgp-card/src/card_do/extended_cap.rs b/openpgp-card/src/card_do/extended_cap.rs index 0239152..f6d3b5e 100644 --- a/openpgp-card/src/card_do/extended_cap.rs +++ b/openpgp-card/src/card_do/extended_cap.rs @@ -128,7 +128,7 @@ mod test { #[test] fn test_yk5() { - // Yubikey 5 + // YubiKey 5 let data = hex!("7d 00 0b fe 08 00 00 ff 00 00"); let ec = ExtendedCapabilities::try_from((&data[..], 0x0304)).unwrap(); diff --git a/openpgp-card/src/card_do/historical.rs b/openpgp-card/src/card_do/historical.rs index c39127e..8e3574d 100644 --- a/openpgp-card/src/card_do/historical.rs +++ b/openpgp-card/src/card_do/historical.rs @@ -187,7 +187,7 @@ impl TryFrom<&[u8]> for HistoricalBytes { // Ignore final two (status) bytes: // according to the spec, they 'normally' show [0x90, 0x0] - but - // Yubikey Neo shows [0x0, 0x0]. + // YubiKey Neo shows [0x0, 0x0]. // It's unclear if these status bytes are ever useful to process? let cc = cc.map(CardCapabilities::from); diff --git a/openpgp-card/src/keys.rs b/openpgp-card/src/keys.rs index 366cb57..3e27677 100644 --- a/openpgp-card/src/keys.rs +++ b/openpgp-card/src/keys.rs @@ -293,7 +293,7 @@ pub(crate) fn determine_ecc_attrs( // Note: Looking up ecc_type in the card's "Algorithm Information" // seems to do more harm than good, so we don't do it. // Some cards report erroneous information about supported algorithms - // - e.g. Yubikey 5 reports support for EdDSA over Cv25519 and + // - e.g. YubiKey 5 reports support for EdDSA over Cv25519 and // Ed25519, but not ECDH. // // We do however, use import_format from algorithm information. diff --git a/openpgp-card/src/lib.rs b/openpgp-card/src/lib.rs index 89b1d5e..ca27022 100644 --- a/openpgp-card/src/lib.rs +++ b/openpgp-card/src/lib.rs @@ -3,7 +3,7 @@ //! Client library for //! [OpenPGP card](https://en.wikipedia.org/wiki/OpenPGP_card) -//! devices (such as Gnuk, Yubikey, or Java smartcards running an OpenPGP +//! devices (such as Gnuk, YubiKey, or Java smartcards running an OpenPGP //! card application). //! //! This library aims to offer diff --git a/openpgp-card/src/openpgp.rs b/openpgp-card/src/openpgp.rs index d92fd81..758f3a0 100644 --- a/openpgp-card/src/openpgp.rs +++ b/openpgp-card/src/openpgp.rs @@ -214,10 +214,10 @@ impl<'a> OpenPgpTransaction<'a> { /// [`set_cardholder_certificate`](OpenPgpTransaction::set_cardholder_certificate) /// in OpenPGP card. /// - /// `yk_workaround`: Yubikey 5 up to (and including) firmware version 5.4.3 need a workaround + /// `yk_workaround`: YubiKey 5 up to (and including) firmware version 5.4.3 need a workaround /// for this command. Set to `true` to apply this workaround. /// (When sending the SELECT DATA command as defined in the card spec, without enabling the - /// workaround, bad Yubikey firmware versions (<= 5.4.3) return + /// workaround, bad YubiKey firmware versions (<= 5.4.3) return /// [`IncorrectParametersCommandDataField`](StatusBytes::IncorrectParametersCommandDataField)) /// /// (This library leaves it up to consumers to decide on a strategy for dealing with this @@ -241,7 +241,7 @@ impl<'a> OpenPgpTransaction<'a> { let mut data = tlv.serialize(); if yk_workaround { - // Workaround for Yubikey 5. + // Workaround for YubiKey 5. // This hack is needed <= 5.4.3 according to ykman sources // (see _select_certificate() in ykman/openpgp.py). diff --git a/openpgp-card/src/tlv.rs b/openpgp-card/src/tlv.rs index 2a72fbb..2151d48 100644 --- a/openpgp-card/src/tlv.rs +++ b/openpgp-card/src/tlv.rs @@ -134,7 +134,7 @@ mod test { #[test] fn test_tlv_yubi5() -> Result<(), Error> { - // 'Yubikey 5 NFC' output for GET DATA on "Application Related Data" + // 'YubiKey 5 NFC' output for GET DATA on "Application Related Data" let data = hex!("6e8201374f10d27600012401030400061601918000005f520800730000e00590007f740381012073820110c00a7d000bfe080000ff0000c106010800001100c206010800001100c306010800001100da06010800001100c407ff7f7f7f030003c5500000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c6500000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000cd1000000000000000000000000000000000de0801000200030081027f660802020bfe02020bfed6020020d7020020d8020020d9020020"); let tlv = Tlv::try_from(&data[..])?; diff --git a/tools/README.md b/tools/README.md index 6f1d8f4..e702ca8 100644 --- a/tools/README.md +++ b/tools/README.md @@ -626,7 +626,7 @@ be prompted to enter the user or Admin PINs where needed. Yubico implements a [proprietary extension](https://developers.yubico.com/PGP/Attestation.html) to the OpenPGP card standard to *"cryptographically certify that a certain asymmetric key has been generated on device, and not imported"*. -This feature is available on Yubikey 5 devices with firmware version 5.2 or newer. +This feature is available on YubiKey 5 devices with firmware version 5.2 or newer. #### Attestation key/certificate @@ -634,7 +634,7 @@ This feature is available on Yubikey 5 devices with firmware version 5.2 or newe The template and key are replaceable, which permits an individual or organization to issue attestations verifiable with their own CA if they prefer. If replaced, the Yubico template can never be restored."* -This tool does not currently support replacing the attestation key on a Yubikey. +This tool does not currently support replacing the attestation key on a YubiKey. It only supports use of the Yubico-provided attestation key to generate "attestation statements". The attestation certificate on a card can be inspected as follows: @@ -667,7 +667,7 @@ Generation of an attestation requires the User PIN. By default it also requires #### Viewing an attestation statement -When the Yubikey generates an attestation statement, it gets stored in a `cardholder certificate` data object on the card. +When the YubiKey generates an attestation statement, it gets stored in a `cardholder certificate` data object on the card. After an attestation statement has been generated, it can be read from the card and viewed in pem-encoded format: diff --git a/tools/debian/control b/tools/debian/control index d74f234..e2c36a2 100644 --- a/tools/debian/control +++ b/tools/debian/control @@ -20,4 +20,4 @@ Built-Using: ${cargo:Built-Using} Description: tool to manage OpenPGP hardware tokens The opgpcard tool allows you to inspect, configure, administer, factory reset, and generally manage OpenPGP cards (hardware tokens), - such as Gnuk, Yubikeys, Nitrokeys, and similar. + such as Gnuk, YubiKeys, Nitrokeys, and similar.