Expand description
§security-rs
Safe Rust bindings for Apple’s Security framework on macOS.
Status: v0.2.1 extends the Swift-bridge-backed safe API with access-control creation, Security item import/export, raw key import, modern signatures, and generic policy property builders.
§Highlights
- Swift bridge over
Security.frameworkwith retained opaque handles and ergonomic Rust wrappers. - Raw C FFI preserved behind the
raw-ffiCargo feature. - Safe modules for all primary logical areas:
keychainidentitycertificatekeypolicytrustauthorizationcoderandom_bytestransformsecure_transportcmskey_derivationkey_agreement
- 14 numbered headless examples plus smoke tests across every area.
§Quick start
use security::prelude::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let certificate = Certificate::from_der(&std::fs::read("tests/fixtures/test-cert.der")?)?;
let policy = Policy::basic_x509()?;
let mut trust = Trust::new(&certificate, &[policy])?;
trust.set_anchor_certificates(&[certificate])?;
trust.set_anchor_certificates_only(true)?;
trust.evaluate()?;
let encoded = Transform::encode_base64(b"hello")?;
assert_eq!(Transform::decode_base64(encoded.as_bytes())?, b"hello");
let random = SecureRandom::bytes(16)?;
assert_eq!(random.len(), 16);
Ok(())
}§Area overview
Keychain: generic-password CRUD, service account listing, and access-control creation.Identity: PKCS#12 import, certificate access, and private-key attribute inspection.Certificate: DER/PEM loading, Security item import/export, summaries, names, emails, serials, validity dates, and public keys.Key: raw/private-key import plus modern signing and signature verification helpers.Policy/Trust: basic X.509, SSL, revocation, generic property builders, custom anchors, and evaluated trust results.Authorization: authorization creation and external-form round trips.Code: current-process code objects, static-code inspection, designated requirements, and task entitlements.RandomBytes:SecRandomCopyByteswrappers.Transform: base64 encode/decode using deprecated but still functionalSecTransformAPIs.SecureTransport: minimal context creation, protocol bounds, and state inspection.CMS: certificate-bag encode/decode.KeyDerivation: PBKDF2-style symmetric-key derivation throughSecKeyDeriveFromPassword.KeyAgreement: ephemeral P-256 key generation and ECDH shared-secret derivation.
§Examples
Run every numbered example:
for ex in examples/*.rs; do cargo run --example "$(basename "$ex" .rs)"; doneKey examples:
01_keychain_password05_trust_evaluate07_code_signing_info11_cms_cert_bag13_key_agreement_shared_secret14_key_import_sign_verify
§Raw FFI
Enable the legacy raw C declarations when you need direct Security.framework symbols:
cargo test --features raw-ffiThe default API path stays on the Swift bridge so Rust code does not call the C-only framework surface directly.
§Coverage notes
See COVERAGE.md for the header audit and per-area implementation / partial / skipped status.
§License
Licensed under either of Apache-2.0 or MIT at your option.
§API documentation
Safe Rust bindings for Apple’s Security.framework on macOS.
Re-exports§
pub use authorization::Authorization;pub use authorization::AuthorizationOptions;pub use certificate::Certificate;pub use certificate::PublicKey;pub use cms::Cms;pub use code::Code;pub use code::SigningInformation;pub use code::SigningValue;pub use code::StaticCode;pub use code::Task;pub use error::OsStatus;pub use error::Result;pub use error::SecurityError;pub use error::StatusError;pub use identity::Identity;pub use key::ExternalFormat;pub use key::ExternalItemType;pub use key::KeyType;pub use key::PrivateKey;pub use key::SignatureAlgorithm;pub use key_agreement::AgreementPrivateKey;pub use key_agreement::AgreementPublicKey;pub use key_derivation::DerivedKey;pub use key_derivation::KeyDerivation;pub use keychain::AccessControl;pub use keychain::AccessControlFlags;pub use keychain::AccessControlProtection;pub use keychain::Keychain;pub use keychain::KeychainEntry;pub use policy::Policy;pub use policy::PolicyIdentifier;pub use policy::PolicyName;pub use policy::PolicyProperties;pub use policy::RevocationFlags;pub use random_bytes::SecureRandom;pub use secure_transport::ProtocolVersion;pub use secure_transport::SecureTransportContext;pub use secure_transport::SecureTransportState;pub use transform::Transform;pub use trust::Trust;
Modules§
- authorization
- certificate
- cms
- code
- code_
signing - error
- Errors returned by the
security-rsbindings. - ffi
raw-ffi - Raw FFI declarations for the subset of
Security.frameworkused by this crate. - identity
- key
- key_
agreement - key_
derivation - keychain
- policy
- prelude
- Common imports for users of this crate.
- random
- random_
bytes - secure_
transport - transform
- trust