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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
use crate::{Bytes, String, Vec};
use serde::{Deserialize, Serialize};
use serde_indexed::{DeserializeIndexed, SerializeIndexed};
use super::{AuthenticatorOptions, PinAuth};
use crate::ctap2::credential_management::CredentialProtectionPolicy;
use crate::sizes::*;
use crate::webauthn::*;
// // Approach 1:
// pub type AuthenticatorExtensions = heapless::LinearMap<String<11>, bool, 2>;
// impl TryFrom<&String<44>> for CredentialProtectionPolicy {
// type Error = crate::authenticator::Error;
// fn try_from(value: &String<44>) -> Result<Self, Self::Error> {
// Ok(match value.as_str() {
// "userVerificationOptional" => CredentialProtectionPolicy::Optional,
// "userVerificationOptionalWithCredentialIDList" => CredentialProtectionPolicy::OptionalWithCredentialIdList,
// "userVerificationRequired" => CredentialProtectionPolicy::Required,
// _ => return Err(Self::Error::InvalidParameter),
// })
// }
// }
impl TryFrom<u8> for CredentialProtectionPolicy {
type Error = super::Error;
fn try_from(value: u8) -> Result<Self, Self::Error> {
Ok(match value {
1 => CredentialProtectionPolicy::Optional,
2 => CredentialProtectionPolicy::OptionalWithCredentialIdList,
3 => CredentialProtectionPolicy::Required,
_ => return Err(Self::Error::InvalidParameter),
})
}
}
// Approach 2:
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct Extensions {
#[serde(rename = "credProtect")]
#[serde(skip_serializing_if = "Option::is_none")]
// pub cred_protect: Option<CredentialProtectionPolicy>,
pub cred_protect: Option<u8>,
// #[serde(serialize_with = "u8::from")]
// pub cred_protect: Option<u8>,
#[serde(rename = "hmac-secret")]
#[serde(skip_serializing_if = "Option::is_none")]
pub hmac_secret: Option<bool>,
}
// // Approach 3:
// #[derive(Clone,Debug,Eq,PartialEq,Serialize,Deserialize)]
// pub enum AuthenticatorExtension {
// #[serde(rename = "hmac-secret")]
// HmacSecret(bool),
// #[serde(rename = "credProtect")]
// CredProtect(bool),
// }
// #[derive(Clone,Debug,Eq,PartialEq,Serialize,Deserialize)]
// pub struct AuthenticatorExtensions {
// #[serde(flatten)]
// pub extensions: Vec<AuthenticatorExtension, 3>,
// }
#[derive(Clone, Debug, Eq, PartialEq, SerializeIndexed, DeserializeIndexed)]
// #[serde(rename_all = "camelCase")]
#[serde_indexed(offset = 1)]
pub struct Request {
pub client_data_hash: Bytes<32>,
pub rp: PublicKeyCredentialRpEntity,
pub user: PublicKeyCredentialUserEntity,
// e.g. webauthn.io sends 10
pub pub_key_cred_params: Vec<PublicKeyCredentialParameters, 12>,
#[serde(skip_serializing_if = "Option::is_none")]
pub exclude_list: Option<Vec<PublicKeyCredentialDescriptor, 16>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<Extensions>,
#[serde(skip_serializing_if = "Option::is_none")]
pub options: Option<AuthenticatorOptions>,
#[serde(skip_serializing_if = "Option::is_none")]
pub pin_auth: Option<PinAuth>,
#[serde(skip_serializing_if = "Option::is_none")]
pub pin_protocol: Option<u32>,
}
// It would be logical to call this Reponse :)
pub type AttestationObject = Response;
//
// TODO: We have `Option<T>`, use it to combine
// `fmt` and `att_stmt`!
//
// #[derive(Clone,Debug,Eq,PartialEq,Serialize)]
// #[serde(into = "ResponseExplicitEnumOption")]
// pub struct Response {
// pub auth_data: Bytes<AUTHENTICATOR_DATA_LENGTH>,
// pub att_stmt: Option<AttestationStatement>,
// }
pub type AuthenticatorData = super::AuthenticatorData<AttestedCredentialData, Extensions>;
// #[derive(Clone,Debug,Eq,PartialEq)]
// // #[serde(rename_all = "camelCase")]
// pub struct AuthenticatorData {
// pub rp_id_hash: Bytes<32>,
// pub flags: Flags,
// pub sign_count: u32,
// // this can get pretty long
// // pub attested_credential_data: Option<Bytes<ATTESTED_CREDENTIAL_DATA_LENGTH>>,
// pub attested_credential_data: Option<AttestedCredentialData>,
// pub extensions: Option<Extensions>
// }
// pub type SerializedAuthenticatorData = Bytes<AUTHENTICATOR_DATA_LENGTH>;
// // The reason for this non-use of CBOR is for compatibility with
// // FIDO U2F authentication signatures.
// impl AuthenticatorData {
// pub fn serialize(&self) -> SerializedAuthenticatorData {
// // let mut bytes = Vec::<u8, AUTHENTICATOR_DATA_LENGTH>::new();
// let mut bytes = SerializedAuthenticatorData::new();
// // 32 bytes, the RP id's hash
// bytes.extend_from_slice(&self.rp_id_hash).unwrap();
// // flags
// bytes.push(self.flags.bits()).unwrap();
// // signature counts as 32-bit unsigned big-endian integer.
// bytes.extend_from_slice(&self.sign_count.to_be_bytes()).unwrap();
// // the attested credential data
// if let Some(ref attested_credential_data) = &self.attested_credential_data {
// bytes.extend_from_slice(&attested_credential_data.serialize()).unwrap();
// }
// // the extensions data
// if let Some(ref extensions) = &self.extensions {
// let mut extensions_buf = [0u8; 128];
// let ser = crate::serde::cbor_serialize(&extensions, &mut extensions_buf).unwrap();
// bytes.extend_from_slice(ser).unwrap();
// }
// bytes
// }
// }
// NOTE: This is not CBOR, it has a custom encoding...
// https://www.w3.org/TR/webauthn/#sec-attested-credential-data
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct AttestedCredentialData {
pub aaguid: Bytes<16>,
// this is where "unlimited non-resident keys" get stored
// TODO: Model as actual credential ID, with ser/de to bytes (format is up to authenticator)
pub credential_id: Bytes<MAX_CREDENTIAL_ID_LENGTH>,
// pub credential_public_key: crate::cose::PublicKey,//Bytes<COSE_KEY_LENGTH>,
pub credential_public_key: Bytes<COSE_KEY_LENGTH>,
}
impl super::SerializeAttestedCredentialData for AttestedCredentialData {
fn serialize(&self) -> Bytes<ATTESTED_CREDENTIAL_DATA_LENGTH> {
let mut bytes = Vec::<u8, ATTESTED_CREDENTIAL_DATA_LENGTH>::new();
// 16 bytes, the aaguid
bytes.extend_from_slice(&self.aaguid).unwrap();
// byte length of credential ID as 16-bit unsigned big-endian integer.
bytes
.extend_from_slice(&(self.credential_id.len() as u16).to_be_bytes())
.unwrap();
// raw bytes of credential ID
bytes
.extend_from_slice(&self.credential_id[..self.credential_id.len()])
.unwrap();
// use existing `bytes` buffer
// let mut cbor_key = [0u8; 128];
// CHANGE this back if credential_public_key is not serialized again
// let l = crate::serde::cbor_serialize(&self.credential_public_key, &mut cbor_key).unwrap();
// bytes.extend_from_slice(&cbor_key[..l]).unwrap();
bytes
.extend_from_slice(&self.credential_public_key)
.unwrap();
Bytes::from(bytes)
}
}
#[derive(Clone, Debug, Eq, PartialEq, SerializeIndexed)]
#[serde_indexed(offset = 1)]
pub struct Response {
pub fmt: String<32>,
pub auth_data: super::SerializedAuthenticatorData,
// pub att_stmt: Bytes<64>,
pub att_stmt: AttestationStatement,
}
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(untagged)]
#[allow(clippy::large_enum_variant)]
pub enum AttestationStatement {
None(NoneAttestationStatement),
Packed(PackedAttestationStatement),
}
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(untagged)]
pub enum AttestationStatementFormat {
None,
Packed,
// Tpm,
// AndroidKey,
// AndroidSafetynet,
// FidoU2f,
}
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct NoneAttestationStatement {}
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct PackedAttestationStatement {
pub alg: i32,
pub sig: Bytes<ASN1_SIGNATURE_LENGTH>,
#[serde(skip_serializing_if = "Option::is_none")]
pub x5c: Option<Vec<Bytes<1024>, 1>>,
}