turnkey/openpgp-card
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rename StatusByte -> StatusBytes

Browse source
This commit is contained in:
Heiko Schaefer 2021-09-07 11:50:20 +02:00
parent a52f3a648e
commit c5d03bd677
5 changed files with 42 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
card-functionality/src/tests.rs
View file

@ -13,7 +13,7 @@ use sequoia_openpgp::Cert;
use openpgp_card; use openpgp_card;
use openpgp_card::algorithm::AlgoSimple; use openpgp_card::algorithm::AlgoSimple;
use openpgp_card::card_do::{KeyGenerationTime, Sex}; use openpgp_card::card_do::{KeyGenerationTime, Sex};
use openpgp_card::{CardApp, Error, KeyType, StatusByte}; use openpgp_card::{CardApp, Error, KeyType, StatusBytes};
use openpgp_card_sequoia::{ use openpgp_card_sequoia::{
make_cert, public_key_material_to_key, public_to_fingerprint, make_cert, public_key_material_to_key, public_to_fingerprint,
}; };
@ -23,7 +23,7 @@ use crate::util;
#[derive(Debug)] #[derive(Debug)]
pub enum TestResult { pub enum TestResult {
Status(StatusByte), Status(StatusBytes),
StatusOk, StatusOk,
Text(String), Text(String),
} }
@ -39,7 +39,7 @@ pub enum TestError {
OPGP(#[from] Error), OPGP(#[from] Error),
#[error(transparent)] #[error(transparent)]
OCard(#[from] StatusByte), OCard(#[from] StatusBytes),
#[error(transparent)] #[error(transparent)]
Other(#[from] anyhow::Error), // source and Display delegate to anyhow::Error Other(#[from] anyhow::Error), // source and Display delegate to anyhow::Error
@ -486,7 +486,7 @@ pub fn test_verify(
let res = ca.set_name("Notverified<<Hello"); let res = ca.set_name("Notverified<<Hello");
if let Err(Error::CardStatus(s)) = res { if let Err(Error::CardStatus(s)) = res {
assert_eq!(s, StatusByte::SecurityStatusNotSatisfied); assert_eq!(s, StatusBytes::SecurityStatusNotSatisfied);
} else { } else {
panic!("Status should be 'SecurityStatusNotSatisfied'"); panic!("Status should be 'SecurityStatusNotSatisfied'");
} }

6
openpgp-card/src/apdu.rs
View file

@ -12,7 +12,7 @@ use anyhow::Result;
use std::convert::TryFrom; use std::convert::TryFrom;
use crate::apdu::{command::Command, response::RawResponse}; use crate::apdu::{command::Command, response::RawResponse};
use crate::{CardClientBox, Error, StatusByte}; use crate::{CardClientBox, Error, StatusBytes};
// "Maximum amount of bytes in a short APDU command or response" (from pcsc) // "Maximum amount of bytes in a short APDU command or response" (from pcsc)
const MAX_BUFFER_SIZE: usize = 264; const MAX_BUFFER_SIZE: usize = 264;
@ -53,7 +53,7 @@ pub(crate) fn send_command(
// Only continue if status is 0x61xx or 0x9000. // Only continue if status is 0x61xx or 0x9000.
if next.status().0 != 0x61 && next.status() != (0x90, 0x0) { if next.status().0 != 0x61 && next.status() != (0x90, 0x0) {
return Err(Error::CardStatus(StatusByte::from(next.status()))); return Err(Error::CardStatus(StatusBytes::from(next.status())));
} }
log::debug!(" appending {} bytes to response", next.raw_data().len()); log::debug!(" appending {} bytes to response", next.raw_data().len());
@ -177,7 +177,7 @@ fn send_command_low_level(
|| (sw1 == 0x68 && sw2 == 0x83)) || (sw1 == 0x68 && sw2 == 0x83))
{ {
// Unexpected status for a non-final chunked response // Unexpected status for a non-final chunked response
return Err(StatusByte::from((sw1, sw2)).into()); return Err(StatusBytes::from((sw1, sw2)).into());
} }
// ISO: "If SW1-SW2 is set to '6884', then command // ISO: "If SW1-SW2 is set to '6884', then command

10
openpgp-card/src/apdu/response.rs
View file

@ -1,7 +1,7 @@
// SPDX-FileCopyrightText: 2021 Heiko Schaefer <heiko@schaefer.name> // SPDX-FileCopyrightText: 2021 Heiko Schaefer <heiko@schaefer.name>
// SPDX-License-Identifier: MIT OR Apache-2.0 // SPDX-License-Identifier: MIT OR Apache-2.0
use crate::{Error, StatusByte}; use crate::{Error, StatusBytes};
use std::convert::TryFrom; use std::convert::TryFrom;
/// Response from the card to a command. /// Response from the card to a command.
@ -41,21 +41,21 @@ impl TryFrom<RawResponse> for Response {
if value.is_ok() { if value.is_ok() {
Ok(Response { data: value.data }) Ok(Response { data: value.data })
} else { } else {
Err(Error::CardStatus(StatusByte::from(value.status()))) Err(Error::CardStatus(StatusBytes::from(value.status())))
} }
} }
} }
impl RawResponse { impl RawResponse {
pub fn check_ok(&self) -> Result<(), StatusByte> { pub fn check_ok(&self) -> Result<(), StatusBytes> {
if !self.is_ok() { if !self.is_ok() {
Err(StatusByte::from((self.sw1, self.sw2))) Err(StatusBytes::from((self.sw1, self.sw2)))
} else { } else {
Ok(()) Ok(())
} }
} }
pub fn data(&self) -> Result<&[u8], StatusByte> { pub fn data(&self) -> Result<&[u8], StatusBytes> {
self.check_ok()?; self.check_ok()?;
Ok(&self.data) Ok(&self.data)
} }

58
openpgp-card/src/errors.rs
View file

@ -18,7 +18,7 @@ pub enum Error {
Smartcard(SmartcardError), Smartcard(SmartcardError),
#[error("OpenPGP card error status: {0}")] #[error("OpenPGP card error status: {0}")]
CardStatus(StatusByte), CardStatus(StatusBytes),
#[error("Command too long ({0} bytes)")] #[error("Command too long ({0} bytes)")]
CommandTooLong(usize), CommandTooLong(usize),
@ -30,8 +30,8 @@ pub enum Error {
InternalError(anyhow::Error), InternalError(anyhow::Error),
} }
impl From<StatusByte> for Error { impl From<StatusBytes> for Error {
fn from(oce: StatusByte) -> Self { fn from(oce: StatusBytes) -> Self {
Error::CardStatus(oce) Error::CardStatus(oce)
} }
} }
@ -42,10 +42,10 @@ impl From<anyhow::Error> for Error {
} }
} }
/// OpenPGP card "Status Byte" errors /// OpenPGP card "Status Bytes" errors
#[derive(thiserror::Error, Debug, PartialEq)] #[derive(thiserror::Error, Debug, PartialEq)]
#[non_exhaustive] #[non_exhaustive]
pub enum StatusByte { pub enum StatusBytes {
#[error("Selected file or DO in termination state")] #[error("Selected file or DO in termination state")]
TerminationState, TerminationState,
@ -116,34 +116,34 @@ pub enum StatusByte {
UnknownStatus(u8, u8), UnknownStatus(u8, u8),
} }
impl From<(u8, u8)> for StatusByte { impl From<(u8, u8)> for StatusBytes {
fn from(status: (u8, u8)) -> Self { fn from(status: (u8, u8)) -> Self {
match (status.0, status.1) { match (status.0, status.1) {
(0x62, 0x85) => StatusByte::TerminationState, (0x62, 0x85) => StatusBytes::TerminationState,
(0x63, 0xC0..=0xCF) => { (0x63, 0xC0..=0xCF) => {
StatusByte::PasswordNotChecked(status.1 & 0xf) StatusBytes::PasswordNotChecked(status.1 & 0xf)
} }
(0x64, 0x02..=0x80) => StatusByte::TriggeringByCard(status.1), (0x64, 0x02..=0x80) => StatusBytes::TriggeringByCard(status.1),
(0x65, 0x01) => StatusByte::MemoryFailure, (0x65, 0x01) => StatusBytes::MemoryFailure,
(0x66, 0x00) => StatusByte::SecurityRelatedIssues, (0x66, 0x00) => StatusBytes::SecurityRelatedIssues,
(0x67, 0x00) => StatusByte::WrongLength, (0x67, 0x00) => StatusBytes::WrongLength,
(0x68, 0x81) => StatusByte::LogicalChannelNotSupported, (0x68, 0x81) => StatusBytes::LogicalChannelNotSupported,
(0x68, 0x82) => StatusByte::SecureMessagingNotSupported, (0x68, 0x82) => StatusBytes::SecureMessagingNotSupported,
(0x68, 0x83) => StatusByte::LastCommandOfChainExpected, (0x68, 0x83) => StatusBytes::LastCommandOfChainExpected,
(0x68, 0x84) => StatusByte::CommandChainingUnsupported, (0x68, 0x84) => StatusBytes::CommandChainingUnsupported,
(0x69, 0x82) => StatusByte::SecurityStatusNotSatisfied, (0x69, 0x82) => StatusBytes::SecurityStatusNotSatisfied,
(0x69, 0x83) => StatusByte::AuthenticationMethodBlocked, (0x69, 0x83) => StatusBytes::AuthenticationMethodBlocked,
(0x69, 0x85) => StatusByte::ConditionOfUseNotSatisfied, (0x69, 0x85) => StatusBytes::ConditionOfUseNotSatisfied,
(0x69, 0x87) => StatusByte::ExpectedSecureMessagingDOsMissing, (0x69, 0x87) => StatusBytes::ExpectedSecureMessagingDOsMissing,
(0x69, 0x88) => StatusByte::SMDataObjectsIncorrect, (0x69, 0x88) => StatusBytes::SMDataObjectsIncorrect,
(0x6A, 0x80) => StatusByte::IncorrectParametersCommandDataField, (0x6A, 0x80) => StatusBytes::IncorrectParametersCommandDataField,
(0x6A, 0x82) => StatusByte::FileOrApplicationNotFound, (0x6A, 0x82) => StatusBytes::FileOrApplicationNotFound,
(0x6A, 0x88) => StatusByte::ReferencedDataNotFound, (0x6A, 0x88) => StatusBytes::ReferencedDataNotFound,
(0x6B, 0x00) => StatusByte::WrongParametersP1P2, (0x6B, 0x00) => StatusBytes::WrongParametersP1P2,
(0x6D, 0x00) => StatusByte::INSNotSupported, (0x6D, 0x00) => StatusBytes::INSNotSupported,
(0x6E, 0x00) => StatusByte::CLANotSupported, (0x6E, 0x00) => StatusBytes::CLANotSupported,
(0x6F, 0x00) => StatusByte::NoPreciseDiagnosis, (0x6F, 0x00) => StatusBytes::NoPreciseDiagnosis,
_ => StatusByte::UnknownStatus(status.0, status.1), _ => StatusBytes::UnknownStatus(status.0, status.1),
} }
} }
} }

2
openpgp-card/src/lib.rs
View file

@ -38,7 +38,7 @@ mod tlv;
pub use crate::apdu::response::Response; pub use crate::apdu::response::Response;
pub use crate::card_app::CardApp; pub use crate::card_app::CardApp;
pub use crate::errors::{Error, SmartcardError, StatusByte}; pub use crate::errors::{Error, SmartcardError, StatusBytes};
/// The CardClient trait defines communication with an OpenPGP card via a /// The CardClient trait defines communication with an OpenPGP card via a
/// backend implementation (e.g. the pcsc backend in the crate /// backend implementation (e.g. the pcsc backend in the crate