Struct RotateableKeySet

pub struct RotateableKeySet {
    encapsulated_downstream_key: UnsignedSharedKey,
    encrypted_encapsulation_key: EncString,
    encrypted_decapsulation_key: EncString,
}

A set of keys where a given DownstreamKey is protected by an encrypted public/private key-pair. The DownstreamKey is used to encrypt/decrypt data, while the public/private key-pair is used to rotate the DownstreamKey.

The PrivateKey is protected by an UpstreamKey, such as a DeviceKey, or PrfKey, and the PublicKey is protected by the DownstreamKey. This setup allows:

• Access to DownstreamKey by knowing the UpstreamKey
• Rotation to a NewDownstreamKey by knowing the current DownstreamKey, without needing access to the UpstreamKey

Fields

encapsulated_downstream_key: UnsignedSharedKey

DownstreamKey protected by encapsulation key

encrypted_encapsulation_key: EncString

Encapsulation key protected by DownstreamKey

encrypted_decapsulation_key: EncString

Decapsulation key protected by UpstreamKey

Implementations

impl RotateableKeySet

pub fn new<Ids: KeyIds>( ctx: &KeyStoreContext<'_, Ids>, upstream_key: &SymmetricCryptoKey, downstream_key_id: Ids::Symmetric, ) -> Result<Self, CryptoError>

Create a set of keys to allow access to the downstream key via the provided upstream key while allowing the downstream key to be rotated.

fn unlock<Ids: KeyIds>( &self, ctx: &mut KeyStoreContext<'_, Ids>, upstream_key: &SymmetricCryptoKey, downstream_key_id: Ids::Symmetric, ) -> Result<(), CryptoError>

Trait Implementations

impl<UT> ConvertError<UT> for RotateableKeySet

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for RotateableKeySet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RotateableKeySet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for RotateableKeySet

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<RotateableKeySet> for JsValue

where RotateableKeySet: Serialize,

fn from(value: RotateableKeySet) -> Self

Converts to this type from the input type.

impl FromWasmAbi for RotateableKeySet

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for RotateableKeySet

where RotateableKeySet: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for RotateableKeySet

type FfiType = <RotateableKeySet as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for RotateableKeySet

type LiftType = RotateableKeySet

impl<UT> LiftReturn<UT> for RotateableKeySet

type ReturnType = <RotateableKeySet as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for RotateableKeySet

type FfiType = <RotateableKeySet as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for RotateableKeySet

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RotateableKeySet

type ReturnType = <RotateableKeySet as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for RotateableKeySet

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for RotateableKeySet

where RotateableKeySet: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for RotateableKeySet

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<RotateableKeySet>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Serialize for RotateableKeySet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for RotateableKeySet

const DECL: &'static str = "/**\n * A set of keys where a given `DownstreamKey` is protected by an encrypted public/private\n * key-pair. The `DownstreamKey` is used to encrypt/decrypt data, while the public/private key-pair\n * is used to rotate the `DownstreamKey`.\n *\n * The `PrivateKey` is protected by an `UpstreamKey`, such as a `DeviceKey`, or `PrfKey`,\n * and the `PublicKey` is protected by the `DownstreamKey`. This setup allows:\n *\n * - Access to `DownstreamKey` by knowing the `UpstreamKey`\n * - Rotation to a `NewDownstreamKey` by knowing the current `DownstreamKey`, without needing\n * access to the `UpstreamKey`\n */\nexport interface RotateableKeySet {\n /**\n * `DownstreamKey` protected by encapsulation key\n */\n encapsulatedDownstreamKey: UnsignedSharedKey;\n /**\n * Encapsulation key protected by `DownstreamKey`\n */\n encryptedEncapsulationKey: EncString;\n /**\n * Decapsulation key protected by `UpstreamKey`\n */\n encryptedDecapsulationKey: EncString;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl<UT> TypeId<UT> for RotateableKeySet

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for RotateableKeySet

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for RotateableKeySet

where RotateableKeySet: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for RotateableKeySet

fn describe()

impl WasmDescribeVector for RotateableKeySet

fn describe_vector()