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

Add documentation.

Browse source
This commit is contained in:
Heiko Schaefer 2021-08-21 01:19:49 +02:00
parent c3ef90638d
commit 89fda362d1
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
openpgp-card/src/card_app.rs
View file

@ -31,6 +31,7 @@ use crate::{
pub struct ApplicationRelatedData(Tlv); pub struct ApplicationRelatedData(Tlv);
impl ApplicationRelatedData { impl ApplicationRelatedData {
/// Application identifier (AID), ISO 7816-4
pub fn get_aid(&self) -> Result<ApplicationId, OpenpgpCardError> { pub fn get_aid(&self) -> Result<ApplicationId, OpenpgpCardError> {
// get from cached "application related data" // get from cached "application related data"
let aid = self.0.find(&Tag::from([0x4F])); let aid = self.0.find(&Tag::from([0x4F]));
@ -42,6 +43,7 @@ impl ApplicationRelatedData {
} }
} }
/// Historical bytes
pub fn get_historical(&self) -> Result<Historical, OpenpgpCardError> { pub fn get_historical(&self) -> Result<Historical, OpenpgpCardError> {
// get from cached "application related data" // get from cached "application related data"
let hist = self.0.find(&Tag::from([0x5F, 0x52])); let hist = self.0.find(&Tag::from([0x5F, 0x52]));
@ -54,6 +56,8 @@ impl ApplicationRelatedData {
} }
} }
/// Extended length information (ISO 7816-4) with maximum number of
/// bytes for command and response.
pub fn get_extended_length_information( pub fn get_extended_length_information(
&self, &self,
) -> Result<Option<ExtendedLengthInfo>> { ) -> Result<Option<ExtendedLengthInfo>> {
@ -79,6 +83,7 @@ impl ApplicationRelatedData {
unimplemented!() unimplemented!()
} }
/// Extended Capabilities
pub fn get_extended_capabilities( pub fn get_extended_capabilities(
&self, &self,
) -> Result<ExtendedCap, OpenpgpCardError> { ) -> Result<ExtendedCap, OpenpgpCardError> {
@ -92,6 +97,7 @@ impl ApplicationRelatedData {
} }
} }
/// Algorithm attributes (for each key type)
pub fn get_algorithm_attributes(&self, key_type: KeyType) -> Result<Algo> { pub fn get_algorithm_attributes(&self, key_type: KeyType) -> Result<Algo> {
// get from cached "application related data" // get from cached "application related data"
let aa = self.0.find(&Tag::from([key_type.get_algorithm_tag()])); let aa = self.0.find(&Tag::from([key_type.get_algorithm_tag()]));
@ -122,6 +128,8 @@ impl ApplicationRelatedData {
} }
} }
/// Fingerprint, per key type.
/// Zero bytes indicate a not defined private key.
pub fn get_fingerprints( pub fn get_fingerprints(
&self, &self,
) -> Result<KeySet<Fingerprint>, OpenpgpCardError> { ) -> Result<KeySet<Fingerprint>, OpenpgpCardError> {
@ -139,6 +147,7 @@ impl ApplicationRelatedData {
} }
} }
/// Generation dates/times of key pairs
pub fn get_key_generation_times( pub fn get_key_generation_times(
&self, &self,
) -> Result<KeySet<KeyGeneration>, OpenpgpCardError> { ) -> Result<KeySet<KeyGeneration>, OpenpgpCardError> {
@ -168,10 +177,12 @@ pub struct CardApp {
} }
impl CardApp { impl CardApp {
/// Create a CardApp object based on a [`CardClientBox`].
pub fn new(card_client: CardClientBox) -> Self { pub fn new(card_client: CardClientBox) -> Self {
Self { card_client } Self { card_client }
} }
/// Take the CardClientBox out of a CardApp
pub fn take_card(self) -> CardClientBox { pub fn take_card(self) -> CardClientBox {
self.card_client self.card_client
} }

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

@ -377,6 +377,7 @@ pub struct PWStatus {
pub(crate) err_count_pw3: u8, pub(crate) err_count_pw3: u8,
} }
/// Fingerprint
#[derive(Clone, Eq, PartialEq)] #[derive(Clone, Eq, PartialEq)]
pub struct Fingerprint([u8; 20]); pub struct Fingerprint([u8; 20]);