Skip to main content

localauthentication/
lib.rs

1#![doc = include_str!("../README.md")]
2//!
3//! ---
4//!
5//! # API documentation
6//!
7//! Safe Rust bindings for Apple's `LocalAuthentication.framework` on macOS.
8
9#![cfg_attr(docsrs, feature(doc_cfg))]
10
11pub mod context;
12pub mod error;
13pub mod ffi;
14pub mod la_authentication_requirement;
15pub mod la_context;
16pub mod la_credential;
17pub mod la_error;
18pub mod la_persisted_right;
19pub mod la_policy;
20pub mod la_public_key;
21pub mod la_right;
22pub mod la_right_store;
23mod private;
24
25pub use la_authentication_requirement::{
26    LAAuthenticationRequirement, LABiometryFallbackRequirement,
27};
28pub use la_context::{
29    BiometryType, LAAccessControlOperation, LACompanionType, LAContext, LADomainState,
30    LADomainStateBiometry, LADomainStateCompanion,
31};
32pub use la_credential::{LACredential, LACredentialType};
33pub use la_error::{LAError, LocalAuthenticationError, Result, LA_ERROR_DOMAIN};
34pub use la_persisted_right::{LAPersistedRight, LAPrivateKey, LASecret};
35pub use la_policy::{LAPolicy, Policy};
36pub use la_public_key::{LAPublicKey, SecKeyAlgorithm};
37pub use la_right::{LARight, LARightState};
38pub use la_right_store::LARightStore;
39
40/// Common imports for users of this crate.
41pub mod prelude {
42    pub use crate::la_authentication_requirement::{
43        LAAuthenticationRequirement, LABiometryFallbackRequirement,
44    };
45    pub use crate::la_context::{
46        BiometryType, LAAccessControlOperation, LACompanionType, LAContext, LADomainState,
47        LADomainStateBiometry, LADomainStateCompanion,
48    };
49    pub use crate::la_credential::{LACredential, LACredentialType};
50    pub use crate::la_error::{LAError, LocalAuthenticationError, Result, LA_ERROR_DOMAIN};
51    pub use crate::la_persisted_right::{LAPersistedRight, LAPrivateKey, LASecret};
52    pub use crate::la_policy::{LAPolicy, Policy};
53    pub use crate::la_public_key::{LAPublicKey, SecKeyAlgorithm};
54    pub use crate::la_right::{LARight, LARightState};
55    pub use crate::la_right_store::LARightStore;
56}