/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ use log::{debug, error, trace}; use pkcs11_bindings::*; use rsclientcerts::manager::Manager; use rsclientcerts::{ declare_pkcs11_find_functions, declare_pkcs11_informational_functions, declare_pkcs11_pin_functions, declare_pkcs11_session_functions, declare_pkcs11_sign_functions, declare_unsupported_pkcs11_functions, log_with_thread_id, }; use std::sync::Mutex; mod backend; use backend::Backend; /// The singleton `Manager` that handles state with respect to PKCS#11. Only one thread may use it /// at a time, but there is no restriction on which threads may use it. static MANAGER: Mutex>> = Mutex::new(None); // See osclientcerts for documentation on these same macros. macro_rules! try_to_get_manager_guard { () => { match MANAGER.lock() { Ok(maybe_manager) => maybe_manager, Err(_) => return CKR_DEVICE_ERROR, } }; } macro_rules! manager_guard_to_manager { ($manager_guard:ident) => { match $manager_guard.as_mut() { Some(manager) => manager, None => return CKR_DEVICE_ERROR, } }; } const MANUFACTURER_ID_BYTES: &[u8; 32] = b"Mozilla Corporation "; const LIBRARY_DESCRIPTION_BYTES: &[u8; 32] = b"Remote Certificates Module "; #[allow(non_snake_case)] extern "C" fn C_Initialize(_pInitArgs: CK_VOID_PTR) -> CK_RV { // This will fail if this has already been called, but this isn't a problem because either way, // logging has been initialized. let _ = env_logger::try_init(); let mut manager_guard = try_to_get_manager_guard!(); let _unexpected_previous_manager = manager_guard.replace(Manager::new(vec![Backend::new()])); CKR_OK } #[allow(non_snake_case)] extern "C" fn C_Finalize(_pReserved: CK_VOID_PTR) -> CK_RV { let mut manager_guard = try_to_get_manager_guard!(); match manager_guard.take() { Some(_) => CKR_OK, None => CKR_CRYPTOKI_NOT_INITIALIZED, } } declare_pkcs11_informational_functions!(); declare_pkcs11_session_functions!(); declare_pkcs11_find_functions!(); declare_pkcs11_sign_functions!(); declare_pkcs11_pin_functions!(); declare_unsupported_pkcs11_functions!(); /// To be a valid PKCS #11 module, this list of functions must be supported. This module claims to /// be cryptoki 3.2 in order to support trust objects. static FUNCTION_LIST: CK_FUNCTION_LIST = CK_FUNCTION_LIST { version: CK_VERSION { major: 3, minor: 2 }, C_Initialize: Some(C_Initialize), C_Finalize: Some(C_Finalize), C_GetInfo: Some(C_GetInfo), C_GetFunctionList: None, C_GetSlotList: Some(C_GetSlotList), C_GetSlotInfo: Some(C_GetSlotInfo), C_GetTokenInfo: Some(C_GetTokenInfo), C_GetMechanismList: Some(C_GetMechanismList), C_GetMechanismInfo: Some(C_GetMechanismInfo), C_InitToken: Some(C_InitToken), C_InitPIN: Some(C_InitPIN), C_SetPIN: Some(C_SetPIN), C_OpenSession: Some(C_OpenSession), C_CloseSession: Some(C_CloseSession), C_CloseAllSessions: Some(C_CloseAllSessions), C_GetSessionInfo: Some(C_GetSessionInfo), C_GetOperationState: Some(C_GetOperationState), C_SetOperationState: Some(C_SetOperationState), C_Login: Some(C_Login), C_Logout: Some(C_Logout), C_CreateObject: Some(C_CreateObject), C_CopyObject: Some(C_CopyObject), C_DestroyObject: Some(C_DestroyObject), C_GetObjectSize: Some(C_GetObjectSize), C_GetAttributeValue: Some(C_GetAttributeValue), C_SetAttributeValue: Some(C_SetAttributeValue), C_FindObjectsInit: Some(C_FindObjectsInit), C_FindObjects: Some(C_FindObjects), C_FindObjectsFinal: Some(C_FindObjectsFinal), C_EncryptInit: Some(C_EncryptInit), C_Encrypt: Some(C_Encrypt), C_EncryptUpdate: Some(C_EncryptUpdate), C_EncryptFinal: Some(C_EncryptFinal), C_DecryptInit: Some(C_DecryptInit), C_Decrypt: Some(C_Decrypt), C_DecryptUpdate: Some(C_DecryptUpdate), C_DecryptFinal: Some(C_DecryptFinal), C_DigestInit: Some(C_DigestInit), C_Digest: Some(C_Digest), C_DigestUpdate: Some(C_DigestUpdate), C_DigestKey: Some(C_DigestKey), C_DigestFinal: Some(C_DigestFinal), C_SignInit: Some(C_SignInit), C_Sign: Some(C_Sign), C_SignUpdate: Some(C_SignUpdate), C_SignFinal: Some(C_SignFinal), C_SignRecoverInit: Some(C_SignRecoverInit), C_SignRecover: Some(C_SignRecover), C_VerifyInit: Some(C_VerifyInit), C_Verify: Some(C_Verify), C_VerifyUpdate: Some(C_VerifyUpdate), C_VerifyFinal: Some(C_VerifyFinal), C_VerifyRecoverInit: Some(C_VerifyRecoverInit), C_VerifyRecover: Some(C_VerifyRecover), C_DigestEncryptUpdate: Some(C_DigestEncryptUpdate), C_DecryptDigestUpdate: Some(C_DecryptDigestUpdate), C_SignEncryptUpdate: Some(C_SignEncryptUpdate), C_DecryptVerifyUpdate: Some(C_DecryptVerifyUpdate), C_GenerateKey: Some(C_GenerateKey), C_GenerateKeyPair: Some(C_GenerateKeyPair), C_WrapKey: Some(C_WrapKey), C_UnwrapKey: Some(C_UnwrapKey), C_DeriveKey: Some(C_DeriveKey), C_SeedRandom: Some(C_SeedRandom), C_GenerateRandom: Some(C_GenerateRandom), C_GetFunctionStatus: Some(C_GetFunctionStatus), C_CancelFunction: Some(C_CancelFunction), C_WaitForSlotEvent: Some(C_WaitForSlotEvent), }; /// # Safety /// /// This is the only function this module exposes. NSS calls it to obtain the list of functions /// comprising this module. /// ppFunctionList must be a valid pointer. #[allow(non_snake_case)] #[unsafe(no_mangle)] pub unsafe extern "C" fn RemoteCerts_C_GetFunctionList( ppFunctionList: CK_FUNCTION_LIST_PTR_PTR, ) -> CK_RV { if ppFunctionList.is_null() { return CKR_ARGUMENTS_BAD; } // CK_FUNCTION_LIST_PTR is a *mut CK_FUNCTION_LIST, but as per the // specification, the caller must treat it as *const CK_FUNCTION_LIST. unsafe { *ppFunctionList = std::ptr::addr_of!(FUNCTION_LIST) as CK_FUNCTION_LIST_PTR }; CKR_OK }