Struct JsSignedJson

Source
pub struct JsSignedJson { /* private fields */ }
Expand description

JSON signed by a multicipher key. Since the signature is done on a digest created by {@link digestJson}, the same signature can be validated against different selectively revealed JSON documents.

@see selectiveDigestJson

Implementations§

Source§

impl JsSignedJson

Source

pub fn new( public_key: &JsMPublicKey, content: &JsValue, signature: &JsMSignature, ) -> Result<JsSignedJson, JsValue>

Create {@link SignedJson} from its parts.

Source

pub fn public_key(&self) -> JsMPublicKey

Accessor of the {@link PublicKey} that signed the binary data.

Source

pub fn content(&self) -> Result<JsValue, JsValue>

Accessor of the JSON content.

Source

pub fn signature(&self) -> JsMSignature

Accessor of the {@link Signature}.

Source

pub fn validate(&self) -> bool

Verify if {@link signature} was made by the private key that belongs to {@link publicKey} on the {@link content}.

Source

pub fn validate_with_keyid(&self, signer_id: &JsMKeyId) -> bool

Not only validate the signature, but also check if the provided {@link KeyId} was made from {@link publicKey}.

@see validate

Source

pub fn validate_with_did_doc( &self, did_doc_str: &str, from_height_inc: Option<u32>, until_height_exc: Option<u32>, ) -> Result<JsValue, JsValue>

Not only validate the signature, but also check the signing key had impersonation right the whole time period specified by the optional upper and lower block height boundaries. The DID document serialized as a string provides the whole history of key rights, so depending on the use-case there are three possible outcomes:

  • The signing key had impersonation right the whole time and the signature is valid (green)
  • Cannot prove if the signing key had impersonation right the whole time, but no other issues found (yellow)
  • The signature is invalid or we can prove the signing key did not have impersonation right at any point in the given time interval (red)

The return value is a {@link ValidationResult}

Source

pub fn to_json(&self) -> Result<JsValue, JsValue>

Serialize this object as a JSON in a format used by IOP SSI in several places

Source

pub fn from_json(json: &JsValue) -> Result<JsSignedJson, JsValue>

Deserialize a {@SignedJson} from a JSON in a format used by IOP SSI in several places

Trait Implementations§

Source§

impl From<JsSignedJson> for JsValue

Source§

fn from(value: JsSignedJson) -> JsValue

Converts to this type from the input type.
Source§

impl From<Signed<Value>> for JsSignedJson

Source§

fn from(inner: Signed<Value>) -> JsSignedJson

Converts to this type from the input type.
Source§

impl FromWasmAbi for JsSignedJson

Source§

type Abi = u32

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

unsafe fn from_abi(js: u32) -> JsSignedJson

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for JsSignedJson

Source§

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for JsSignedJson

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<JsSignedJson>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi( js: <JsSignedJson as LongRefFromWasmAbi>::Abi, ) -> <JsSignedJson as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for JsSignedJson

Source§

fn is_none(abi: &<JsSignedJson as FromWasmAbi>::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.
Source§

impl OptionIntoWasmAbi for JsSignedJson

Source§

fn none() -> <JsSignedJson as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for JsSignedJson

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<JsSignedJson>

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.
Source§

unsafe fn ref_from_abi( js: <JsSignedJson as RefFromWasmAbi>::Abi, ) -> <JsSignedJson as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for JsSignedJson

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<JsSignedJson>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi( js: <JsSignedJson as RefMutFromWasmAbi>::Abi, ) -> <JsSignedJson as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl TryFromJsValue for JsSignedJson

Source§

type Error = JsValue

The type returned in the event of a conversion error.
Source§

fn try_from_js_value( value: JsValue, ) -> Result<JsSignedJson, <JsSignedJson as TryFromJsValue>::Error>

Performs the conversion.
Source§

impl VectorFromWasmAbi for JsSignedJson

Source§

impl VectorIntoWasmAbi for JsSignedJson

Source§

impl Wraps<Signed<Value>> for JsSignedJson

Source§

fn inner(&self) -> &Signed<Value>

Converts a reference to a WASM type to a reference to the underlying Rust type.

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V