Skip to content
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

Jump to bottom

Make separate constructors for RO/RW sessions #101

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Make separate constructors for RO/RW sessions #101

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51348b2
Make separate constructors for RO/RW sessions
ionut-arm Sep 2, 2022
38d5538
PR feedback
ionut-arm Sep 6, 2022
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: 14 additions & 3 deletions cryptoki/src/context/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,20 @@ impl Pkcs11 {
slot_token_management::get_mechanism_info(self, slot, type_)
}

/// Open a new session with no callback set
pub fn open_session_no_callback(&self, slot_id: Slot, read_write: bool) -> Result<Session> {
session_management::open_session_no_callback(self, slot_id, read_write)
/// Open a new Read-Only session
///
/// For a Read-Write session, use `open_rw_session`
///
/// Note: No callback is set when opening the session.
pub fn open_ro_session(&self, slot_id: Slot) -> Result<Session> {
session_management::open_session_no_callback(self, slot_id, false)
}

/// Open a new Read/Write session
///
/// Note: No callback is set when opening the session.
pub fn open_rw_session(&self, slot_id: Slot) -> Result<Session> {
session_management::open_session_no_callback(self, slot_id, true)
}

/// Check whether a given PKCS11 spec-defined function is supported by this implementation
Expand Down
2 changes: 1 addition & 1 deletion cryptoki/src/session/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ impl Session {
/// pkcs11.initialize(CInitializeArgs::OsThreads).unwrap();
/// let slot = pkcs11.get_slots_with_token().unwrap().remove(0);
///
/// let session = pkcs11.open_session_no_callback(slot, true).unwrap();
/// let session = pkcs11.open_ro_session(slot).unwrap();
/// session.login(UserType::User, Some("fedcba"));
///
/// let empty_attrib= vec![];
Expand Down
82 changes: 70 additions & 12 deletions cryptoki/tests/basic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ fn sign_verify() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -77,7 +77,7 @@ fn encrypt_decrypt() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -129,7 +129,7 @@ fn derive_key() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -220,7 +220,7 @@ fn import_export() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -286,7 +286,7 @@ fn get_token_info() -> Result<()> {
fn wrap_and_unwrap_key() {
let (pkcs11, slot) = init_pins();
// open a session
let session = pkcs11.open_session_no_callback(slot, true).unwrap();
let session = pkcs11.open_rw_session(slot).unwrap();

// log in the session
session.login(UserType::User, Some(USER_PIN)).unwrap();
Expand Down Expand Up @@ -375,7 +375,7 @@ fn login_feast() {
for _ in 0..SESSIONS {
let pkcs11 = pkcs11.clone();
threads.push(thread::spawn(move || {
let session = pkcs11.open_session_no_callback(slot, true).unwrap();
let session = pkcs11.open_rw_session(slot).unwrap();
match session.login(UserType::User, Some(USER_PIN)) {
Ok(_) | Err(Error::Pkcs11(RvError::UserAlreadyLoggedIn)) => {}
Err(e) => panic!("Bad error response: {}", e),
Expand Down Expand Up @@ -437,7 +437,7 @@ fn get_slot_info_test() -> Result<()> {
fn get_session_info_test() -> Result<()> {
let (pkcs11, slot) = init_pins();
{
let session = pkcs11.open_session_no_callback(slot, false)?;
let session = pkcs11.open_ro_session(slot)?;
let session_info = session.get_session_info()?;
assert!(!session_info.read_write());
assert_eq!(session_info.slot_id(), slot);
Expand All @@ -461,7 +461,7 @@ fn get_session_info_test() -> Result<()> {
}
}

let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;
let session_info = session.get_session_info()?;
assert!(session_info.read_write());
assert_eq!(session_info.slot_id(), slot);
Expand Down Expand Up @@ -493,7 +493,7 @@ fn get_session_info_test() -> Result<()> {
fn generate_random_test() -> Result<()> {
let (pkcs11, slot) = init_pins();

let session = pkcs11.open_session_no_callback(slot, false)?;
let session = pkcs11.open_ro_session(slot)?;

let poor_seed: [u8; 32] = [0; 32];
session.seed_random(&poor_seed)?;
Expand All @@ -517,7 +517,7 @@ fn set_pin_test() -> Result<()> {
let new_user_pin = "123456";
let (pkcs11, slot) = init_pins();

let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

session.login(UserType::User, Some(USER_PIN))?;
session.set_pin(USER_PIN, new_user_pin)?;
Expand All @@ -533,7 +533,7 @@ fn get_attribute_info_test() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -684,7 +684,7 @@ fn aes_key_attributes_test() -> Result<()> {
let (pkcs11, slot) = init_pins();

// open a session
let session = pkcs11.open_session_no_callback(slot, true)?;
let session = pkcs11.open_rw_session(slot)?;

// log in the session
session.login(UserType::User, Some(USER_PIN))?;
Expand Down Expand Up @@ -723,3 +723,61 @@ fn aes_key_attributes_test() -> Result<()> {

Ok(())
}

#[test]
#[serial]
fn ro_rw_session_test() -> Result<()> {
let public_exponent: Vec<u8> = vec![0x01, 0x00, 0x01];
let modulus = vec![0xFF; 1024];

let template = vec![
Attribute::Token(true),
Attribute::Private(false),
Attribute::PublicExponent(public_exponent),
Attribute::Modulus(modulus),
Attribute::Class(ObjectClass::PUBLIC_KEY),
Attribute::KeyType(KeyType::RSA),
Attribute::Verify(true),
];

let (pkcs11, slot) = init_pins();

// Try out Read-Only session
{
// open a session
let ro_session = pkcs11.open_ro_session(slot)?;

// log in the session
ro_session.login(UserType::User, Some(USER_PIN))?;

// generate a key pair
// This should NOT work using the Read/Write session
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you meant "Read-Only" in this comment rather than "Read/Write".

let e = ro_session.create_object(&template).unwrap_err();

if let Error::Pkcs11(RvError::SessionReadOnly) = e {
mohamedasaker-arm marked this conversation as resolved.
Show resolved Hide resolved
// as expected
} else {
panic!("Got wrong error code (expecting SessionReadOnly): {}", e);
}
ro_session.logout()?;
}

// Try out Read/Write session
{
// open a session
let rw_session = pkcs11.open_rw_session(slot)?;

// log in the session
rw_session.login(UserType::User, Some(USER_PIN))?;

// generate a key pair
// This should work using the Read/Write session
let object = rw_session.create_object(&template)?;

// delete keys
rw_session.destroy_object(object)?;
rw_session.logout()?;
}

Ok(())
}
2 changes: 1 addition & 1 deletion cryptoki/tests/common.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub fn init_pins() -> (Pkcs11, Slot) {

{
// open a session
let session = pkcs11.open_session_no_callback(slot, true).unwrap();
let session = pkcs11.open_rw_session(slot).unwrap();
// log in the session
session.login(UserType::So, Some(SO_PIN)).unwrap();
session.init_pin(USER_PIN).unwrap();
Expand Down