Skip to main content

Base64UrlBytes

Struct Base64UrlBytes 

Source
pub struct Base64UrlBytes(/* private fields */);
Expand description

A wrapper around raw bytes that serializes to/from base64url encoding.

This type provides:

  • Base64url encoding without padding (per RFC 7517)
  • Constant-time base64 operations via base64ct
  • Automatic memory zeroing on drop via zeroize
  • Explicit constant-time byte comparison via Base64UrlBytes::ct_eq

§Security Note

PartialEq for this type is a regular byte equality check and is not guaranteed to be constant-time. For secret-dependent comparisons, use Base64UrlBytes::ct_eq.

§Examples

use jwk_simple::encoding::Base64UrlBytes;

// Create from raw bytes
let bytes = Base64UrlBytes::new(vec![1, 2, 3, 4]);

// Serialize to JSON (base64url encoded)
let json = serde_json::to_string(&bytes).unwrap();
assert_eq!(json, "\"AQIDBA\"");

// Deserialize from JSON
let decoded: Base64UrlBytes = serde_json::from_str(&json).unwrap();
assert_eq!(decoded.as_bytes(), &[1, 2, 3, 4]);

Implementations§

Source§

impl Base64UrlBytes

Source

pub fn new(bytes: Vec<u8>) -> Self

Creates a new Base64UrlBytes from raw bytes.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::new(vec![0x01, 0x02, 0x03]);
assert_eq!(bytes.len(), 3);
Source

pub fn from_base64url(encoded: &str) -> Result<Self>

Creates a Base64UrlBytes by decoding a base64url string.

§Errors

Returns an error if the input is not valid base64url.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::from_base64url("AQIDBA").unwrap();
assert_eq!(bytes.as_bytes(), &[1, 2, 3, 4]);
Source

pub fn to_base64url(&self) -> String

Encodes the bytes as a base64url string (without padding).

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::new(vec![1, 2, 3, 4]);
assert_eq!(bytes.to_base64url(), "AQIDBA");
Source

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the underlying bytes.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::new(vec![1, 2, 3]);
assert_eq!(bytes.as_bytes(), &[1, 2, 3]);
Source

pub fn len(&self) -> usize

Returns the length of the underlying bytes.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::new(vec![1, 2, 3]);
assert_eq!(bytes.len(), 3);
Source

pub fn is_empty(&self) -> bool

Returns true if the underlying bytes are empty.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let empty = Base64UrlBytes::new(vec![]);
assert!(empty.is_empty());

let not_empty = Base64UrlBytes::new(vec![1]);
assert!(!not_empty.is_empty());
Source

pub fn into_bytes(self) -> Zeroizing<Vec<u8>>

Consumes the wrapper and returns the underlying bytes.

The returned bytes are wrapped in Zeroizing to ensure they are zeroized on drop, preserving the security guarantees of this type.

§Examples
use jwk_simple::encoding::Base64UrlBytes;

let bytes = Base64UrlBytes::new(vec![1, 2, 3]);
let raw = bytes.into_bytes();
assert_eq!(&*raw, &vec![1, 2, 3]);
Source

pub fn ct_eq(&self, other: &Self) -> bool

Performs a constant-time equality comparison.

Use this method for secret-dependent decisions.

Trait Implementations§

Source§

impl AsRef<[u8]> for Base64UrlBytes

Source§

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Base64UrlBytes

Source§

fn clone(&self) -> Base64UrlBytes

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 ConstantTimeEq for Base64UrlBytes

Source§

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal. Read more
Source§

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal. Read more
Source§

impl Debug for Base64UrlBytes

Source§

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

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

impl<'de> Deserialize<'de> for Base64UrlBytes

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 Drop for Base64UrlBytes

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<&[u8]> for Base64UrlBytes

Source§

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for Base64UrlBytes

Source§

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.
Source§

impl Hash for Base64UrlBytes

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Base64UrlBytes

Source§

fn eq(&self, other: &Base64UrlBytes) -> 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 Serialize for Base64UrlBytes

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 Zeroize for Base64UrlBytes

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.
Source§

impl Eq for Base64UrlBytes

Source§

impl StructuralPartialEq for Base64UrlBytes

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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