Struct nucypher_core::TreasureMap

source · [−]

pub struct TreasureMap {
    pub threshold: u8,
    pub hrac: HRAC,
    pub destinations: BTreeMap<Address, EncryptedKeyFrag>,
    pub policy_encrypting_key: PublicKey,
    pub publisher_verifying_key: PublicKey,
}

Expand description

A structure containing KeyFrag objects encrypted for Ursulas chosen for this policy.

Fields

threshold: u8

Threshold for successful re-encryption.

hrac: HRAC

Policy HRAC.

destinations: BTreeMap<Address, EncryptedKeyFrag>

Encrypted key frags assigned to target Ursulas.

policy_encrypting_key: PublicKey

A key to create encrypted messages under this policy.

publisher_verifying_key: PublicKey

Publisher’s verifying key.

Implementations

source

impl TreasureMap

source

pub fn new(
 signer: &Signer,
 hrac: &HRAC,
 policy_encrypting_key: &PublicKey,
 assigned_kfrags: impl IntoIterator<Item = (Address, (PublicKey, VerifiedKeyFrag))>,
 threshold: u8
) -> Self

Create a new treasure map for a collection of ursulas and kfrags.

Panics if threshold is set to 0, the number of assigned keyfrags is less than threshold, or if the addresses in assigned_kfrags repeat.

source

pub fn encrypt(
    &self,
    signer: &Signer,
    recipient_key: &PublicKey
) -> EncryptedTreasureMap

Encrypts the treasure map for Bob.

source

pub fn make_revocation_orders(&self, signer: &Signer) -> Vec<RevocationOrder>

Makes revocation orders for all destinations in the treasure map.

Trait Implementations

source

impl Clone for TreasureMap

source

fn clone(&self) -> TreasureMap

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for TreasureMap

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for TreasureMap

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl PartialEq<TreasureMap> for TreasureMap

source

fn eq(&self, other: &TreasureMap) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &TreasureMap) -> bool

This method tests for !=.

source

impl<'a> ProtocolObject<'a> for TreasureMap

source

fn version() -> (u16, u16)

supported by the current implementation.

source

fn to_bytes(&self) -> Box<[u8]>

Serializes the object.

source

fn from_bytes(bytes: &'a [u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the object.

source

impl Serialize for TreasureMap

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl StructuralPartialEq for TreasureMap

Auto Trait Implementations

impl RefUnwindSafe for TreasureMap

impl Send for TreasureMap

impl Sync for TreasureMap

impl Unpin for TreasureMap

impl UnwindSafe for TreasureMap

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct nucypher_core::TreasureMap

Fields

Implementations

impl TreasureMap

pub fn new( signer: &Signer, hrac: &HRAC, policy_encrypting_key: &PublicKey, assigned_kfrags: impl IntoIterator<Item = (Address, (PublicKey, VerifiedKeyFrag))>, threshold: u8) -> Self

pub fn encrypt( &self, signer: &Signer, recipient_key: &PublicKey) -> EncryptedTreasureMap

pub fn make_revocation_orders(&self, signer: &Signer) -> Vec<RevocationOrder>

Trait Implementations

impl Clone for TreasureMap

fn clone(&self) -> TreasureMap

fn clone_from(&mut self, source: &Self)

impl Debug for TreasureMap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<'de> Deserialize<'de> for TreasureMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl PartialEq<TreasureMap> for TreasureMap

fn eq(&self, other: &TreasureMap) -> bool

fn ne(&self, other: &TreasureMap) -> bool

impl<'a> ProtocolObject<'a> for TreasureMap

fn version() -> (u16, u16)

fn to_bytes(&self) -> Box<[u8]>

fn from_bytes(bytes: &'a [u8]) -> Result<Self, DeserializationError>

impl Serialize for TreasureMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

impl StructuralPartialEq for TreasureMap

Auto Trait Implementations

impl RefUnwindSafe for TreasureMap

impl Send for TreasureMap

impl Sync for TreasureMap

impl Unpin for TreasureMap

impl UnwindSafe for TreasureMap

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

pub fn new(
signer: &Signer,
hrac: &HRAC,
policy_encrypting_key: &PublicKey,
assigned_kfrags: impl IntoIterator<Item = (Address, (PublicKey, VerifiedKeyFrag))>,
threshold: u8
) -> Self

pub fn encrypt(
&self,
signer: &Signer,
recipient_key: &PublicKey
) -> EncryptedTreasureMap

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,