Skip to content

Add support for vendor defined attributes #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 26, 2024
Merged

Add support for vendor defined attributes #237

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
697a4bf
Add support for vendor defined attributes
jrozner Dec 21, 2024
8aee5bd
Add fixes for feedback
jrozner Dec 21, 2024
2289253
Switch away from CK_ATTRIBUTE_TYPE
jrozner Dec 21, 2024
6264c29
Fix formatting
jrozner Dec 22, 2024
6921373
Add non_exhaustive back
jrozner Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions cryptoki/src/object.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ use std::fmt::Formatter;
use std::mem::size_of;
use std::ops::Deref;

const MAX_CU_ULONG: CK_ULONG = !0;

#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
#[non_exhaustive]
/// Type of an attribute
pub enum AttributeType {
/// DER-encoding of the attribute certificate's issuer
Expand Down Expand Up @@ -128,6 +129,8 @@ pub enum AttributeType {
Value,
/// Length in bytes of the value
ValueLen,
/// Vendor defined attribute
VendorDefined(CK_ATTRIBUTE_TYPE),
/// Determines if a key supports verifying
Verify,
/// Determines if a key supports verifying where the data can be recovered from the signature
Expand Down Expand Up @@ -254,6 +257,9 @@ impl AttributeType {
CKA_UNWRAP_TEMPLATE => String::from(stringify!(CKA_UNWRAP_TEMPLATE)),
CKA_DERIVE_TEMPLATE => String::from(stringify!(CKA_DERIVE_TEMPLATE)),
CKA_ALLOWED_MECHANISMS => String::from(stringify!(CKA_ALLOWED_MECHANISMS)),
CKA_VENDOR_DEFINED..=MAX_CU_ULONG => {
format!("{}_{}", stringify!(CKA_VENDOR_DEFINED), val)
}
_ => format!("unknown ({val:08x})"),
}
}
Expand Down Expand Up @@ -324,6 +330,7 @@ impl From<AttributeType> for CK_ATTRIBUTE_TYPE {
AttributeType::Url => CKA_URL,
AttributeType::Value => CKA_VALUE,
AttributeType::ValueLen => CKA_VALUE_LEN,
AttributeType::VendorDefined(val) => val,
AttributeType::Verify => CKA_VERIFY,
AttributeType::VerifyRecover => CKA_VERIFY_RECOVER,
AttributeType::Wrap => CKA_WRAP,
Expand Down Expand Up @@ -396,6 +403,7 @@ impl TryFrom<CK_ATTRIBUTE_TYPE> for AttributeType {
CKA_VERIFY_RECOVER => Ok(AttributeType::VerifyRecover),
CKA_WRAP => Ok(AttributeType::Wrap),
CKA_WRAP_WITH_TRUSTED => Ok(AttributeType::WrapWithTrusted),
CKA_VENDOR_DEFINED..=MAX_CU_ULONG => Ok(AttributeType::VendorDefined(attribute_type)),
attr_type => {
error!("Attribute type {} not supported.", attr_type);
Err(Error::NotSupported)
Expand All @@ -405,7 +413,6 @@ impl TryFrom<CK_ATTRIBUTE_TYPE> for AttributeType {
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
Copy link
Collaborator

@wiktor-k wiktor-k Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this got removed? Correct me if I'm wrong but vendor defined doesn't cover all space of possible values? 🤔

Copy link
Contributor Author

@jrozner jrozner Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, fixed that. You're correct that it's not exhaustive.

/// Attribute value
pub enum Attribute {
/// DER-encoding of the attribute certificate's issuer
Expand Down Expand Up @@ -518,6 +525,8 @@ pub enum Attribute {
Value(Vec<u8>),
/// Length in bytes of the value
ValueLen(Ulong),
/// Vendor defined value
VendorDefined((AttributeType, Vec<u8>)),
/// Determines if a key supports verifying
Verify(bool),
/// Determines if a key supports verifying where the data can be recovered from the signature
Expand Down Expand Up @@ -587,6 +596,7 @@ impl Attribute {
Attribute::Url(_) => AttributeType::Url,
Attribute::Value(_) => AttributeType::Value,
Attribute::ValueLen(_) => AttributeType::ValueLen,
Attribute::VendorDefined((num, _)) => *num,
Attribute::Verify(_) => AttributeType::Verify,
Attribute::VerifyRecover(_) => AttributeType::VerifyRecover,
Attribute::Wrap(_) => AttributeType::Wrap,
Expand Down Expand Up @@ -658,6 +668,7 @@ impl Attribute {
Attribute::AllowedMechanisms(mechanisms) => {
size_of::<CK_MECHANISM_TYPE>() * mechanisms.len()
}
Attribute::VendorDefined((_, bytes)) => bytes.len(),
}
}

Expand Down Expand Up @@ -730,6 +741,7 @@ impl Attribute {
| Attribute::Subject(bytes)
| Attribute::Url(bytes)
| Attribute::Value(bytes)
| Attribute::VendorDefined((_, bytes))
| Attribute::Id(bytes) => bytes.as_ptr() as *mut c_void,
// Unique types
Attribute::CertificateType(certificate_type) => {
Expand Down Expand Up @@ -930,6 +942,7 @@ impl TryFrom<CK_ATTRIBUTE> for Attribute {
}
}
}
AttributeType::VendorDefined(t) => Ok(Attribute::VendorDefined((AttributeType::VendorDefined(t), val.to_vec()))),
}
}
}
Expand Down
Loading