yubihsm 0.4.0

Pure Rust client for YubiHSM2 devices
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Implementation of the GlobalPlatform Secure Channel Protocol "03"
//!
//! See GPC_SPE_014: GlobalPlatform Card Technology Secure Channel Protocol '03' at:
//! <https://www.globalplatform.org/specificationscard.asp>
//!
//! SCP03 provides an encrypted channel using symmetric encryption alone.
//! AES-128-CBC is used for encryption, and AES-128-CMAC for authentication.
//!
//! While SCP03 is a multipurpose protocol, this implementation has been
//! written with the specific intention of communicating with Yubico's
//! YubiHSM2 devices and therefore omits certain features (e.g. additional
//! key sizes besides 128-bit) which are not relevant to the YubiHSM2 use case.
//!
//! It also follows the APDU format as described in Yubico's YubiHSM2
//! documentation as opposed to the one specified in GPC_SPE_014.
//!
//! For more information on the YubiHSM2 command format, see:
//!
//! <https://developers.yubico.com/YubiHSM2/Commands/>

#![allow(unknown_lints, doc_markdown)]

mod challenge;
mod channel;
mod command_message;
mod context;
mod cryptogram;
mod error;
mod kdf;
mod mac;
mod response_message;
mod static_keys;

/// AES key size in bytes. SCP03 theoretically supports other key sizes, but
/// since this crate is somewhat specialized to the `YubiHSM2` (at least for now)
/// we hardcode to 128-bit for simplicity.
pub const KEY_SIZE: usize = 16;

/// Maximum size of the message buffer
pub const MAX_MSG_SIZE: usize = 2048;

pub use self::challenge::{Challenge, CHALLENGE_SIZE};
pub(crate) use self::channel::Channel;
pub use self::channel::Id as SessionId;
pub(crate) use self::command_message::CommandMessage;
pub use self::command_message::CommandType;
pub use self::context::{Context, CONTEXT_SIZE};
pub use self::cryptogram::{Cryptogram, CRYPTOGRAM_SIZE};
pub use self::error::SecureChannelError;
pub(crate) use self::mac::{Mac, MAC_SIZE};
pub(crate) use self::response_message::{ResponseCode, ResponseMessage};
pub use self::static_keys::StaticKeys;