Context

Struct Context 

Source
pub struct Context<'a>(/* private fields */);
Expand description

The “context” for signing and verifying messages, which is used for domain separation of message signatures. The context can be of length [Context::MIN_LEN..Context::MAX_LEN].

§Example

use did_simple::crypto::Context;
const CTX: Context = Context::from_bytes("MySuperCoolProtocol".as_bytes());

§What is the purpose of this?

Messages signed using one context cannot be verified under a different context. This is important, because it prevents tricking someone into signing a message for one use case, and it getting reused for another use case.

§Can you give me an example of how not using a context can be bad?

Suppose that a scammer sends you a file and asks you to send it back to them signed, to prove to them that you got the message. You naively comply, only later to realize that the file you signed actually is a json message that authorizes your bank to send funds to the scammer. If you reused the same public key for sending messages as you do for authorizing bank transactions, you just got robbed.

If instead the application you were using signed that message with a “MySecureProtocolSendMessage” context, and your bank used “MySuperSafeBank”, your bank would have rejected the message signature when the scammer tried to use it to authorize a funds transfer because the two contexts don’t match.

§But I really need to not use a context for this specific case 🥺

Most of the signing algorithms’ VerifyingKeys expose an into_inner method and reexport the cryptography crate they use. So you can just call the relevant signing functions yourself with the lower level crate.

Implementations§

Source§

impl<'a> Context<'a>

Source

pub const MAX_LEN: usize = 255usize

Source

pub const MIN_LEN: usize = 4usize

Source

pub const fn from_bytes(value: &'a [u8]) -> Self

Panics if value is longer than Self::MAX_LEN or is 0.

Source

pub const fn try_from_bytes(value: &'a [u8]) -> Result<Self, ContextError>

Trait Implementations§

Source§

impl<'a> Clone for Context<'a>

Source§

fn clone(&self) -> Context<'a>

Returns a duplicate 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<'a> Debug for Context<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> PartialEq for Context<'a>

Source§

fn eq(&self, other: &Context<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> TryFrom<&'a [u8]> for Context<'a>

Source§

type Error = ContextError

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

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<'a> Copy for Context<'a>

Source§

impl<'a> Eq for Context<'a>

Source§

impl<'a> StructuralPartialEq for Context<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Context<'a>

§

impl<'a> RefUnwindSafe for Context<'a>

§

impl<'a> Send for Context<'a>

§

impl<'a> Sync for Context<'a>

§

impl<'a> Unpin for Context<'a>

§

impl<'a> UnwindSafe for Context<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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