Struct Membership

Source

pub struct Membership { /* private fields */ }

Expand description

A Membership provides cryptographically signed group affiliations.

Memberships link a member (via their IDCard) to a group (via the group’s public key). They can contain additional information like roles and are cryptographically signed by the group owner to prove authenticity.

§Example

use rust_bottle::*;
use rand::rngs::OsRng;

let rng = &mut OsRng;
let member_key = Ed25519Key::generate(rng);
let member_idcard = IDCard::new(&member_key.public_key_bytes());

let group_key = Ed25519Key::generate(rng);
let mut membership = Membership::new(&member_idcard, &group_key.public_key_bytes());
membership.set_info("role", "admin");

let signed = membership.sign(rng, &group_key).unwrap();

Implementations§

Source §

impl Membership

Source

pub fn new(member_idcard: &IDCard, group_public_key: &[u8]) -> Self

Create a new membership linking a member to a group.

§Arguments

member_idcard - The member’s IDCard
group_public_key - The group’s public key

§Returns

A new Membership instance (not yet signed)

§Example

use rust_bottle::*;
use rand::rngs::OsRng;

let rng = &mut OsRng;
let member_key = Ed25519Key::generate(rng);
let member_idcard = IDCard::new(&member_key.public_key_bytes());

let group_key = Ed25519Key::generate(rng);
let membership = Membership::new(&member_idcard, &group_key.public_key_bytes());

Source

pub fn set_info(&mut self, key: &str, value: &str)

Set information key-value pair.

Information fields can store application-specific data like roles, departments, or other metadata about the membership.

§Arguments

key - Information key
value - Information value

§Example

use rust_bottle::*;
use rand::rngs::OsRng;

let rng = &mut OsRng;
let member_key = Ed25519Key::generate(rng);
let member_idcard = IDCard::new(&member_key.public_key_bytes());
let group_key = Ed25519Key::generate(rng);

let mut membership = Membership::new(&member_idcard, &group_key.public_key_bytes());
membership.set_info("role", "admin");
membership.set_info("department", "Engineering");

Source

pub fn info(&self, key: &str) -> Option<&str>

Get information value by key.

§Arguments

key - Information key to look up

§Returns

Some(&str) if the key exists
None if the key is not found

Source

pub fn sign<R: RngCore>( &mut self, rng: &mut R, signer: &dyn Sign, ) -> Result<Vec<u8>>

Sign the membership with a private key.

This creates a cryptographic signature of the membership (excluding the signature field itself) and stores it. The signed membership is then serialized and returned.

§Arguments

rng - A random number generator
signer - A signer implementing the Sign trait (typically the group owner’s key)

§Returns

Ok(Vec<u8>) - Serialized signed membership
Err(BottleError::Serialization) - If serialization fails
Err(BottleError::VerifyFailed) - If signing fails

§Example

use rust_bottle::*;
use rand::rngs::OsRng;

let rng = &mut OsRng;
let member_key = Ed25519Key::generate(rng);
let member_idcard = IDCard::new(&member_key.public_key_bytes());
let group_key = Ed25519Key::generate(rng);

let mut membership = Membership::new(&member_idcard, &group_key.public_key_bytes());
let signed = membership.sign(rng, &group_key).unwrap();

Source

pub fn verify(&self, _group_idcard: &IDCard) -> Result<()>

Verify the membership signature.

§Note

This is a simplified implementation that only checks for the presence of a signature. Full verification would require extracting the signing key from the group’s IDCard and verifying the signature cryptographically.