Struct TpU16 

pub struct TpU16(/* private fields */);

A number type that prevents its value from being leaked to attackers through timing information.

Use this type’s protect method as early as possible to prevent the value from being used in variable-time computations.

Unlike Rust’s built-in number types, rust-timing-shield number types have no overflow checking, even in debug mode. In other words, they behave like Rust’s Wrapping types.

Additionally, all shift distances are reduced mod the bit width of the type (e.g. some_i64 << 104 is equivalent to some_i64 << 40).

// Protect the value as early as possible to limit the risk
let protected_value = TpU8::protect(some_u8);
let other_protected_value = TpU8::protect(some_other_u8);

// Do some computation with the protected values
let x = (other_protected_value + protected_value) & 0x40;

// If needed, remove protection using `expose`
println!("{}", x.expose());

Implementations

impl TpU16

pub fn protect(input: u16) -> Self

Hide input behind a protective abstraction to prevent the value from being used in such a way that the value could leak out via a timing side channel.

let protected = TpU32::protect(secret_u32);

// Use `protected` instead of `secret_u32` to avoid timing leaks

pub fn as_u8(self) -> TpU8

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_u32(self) -> TpU32

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_u64(self) -> TpU64

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_i8(self) -> TpI8

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_i16(self) -> TpI16

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_i32(self) -> TpI32

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn as_i64(self) -> TpI64

Casts from one number type to another, following the same conventions as Rust’s as keyword.

pub fn rotate_left(self, n: u32) -> Self

Shifts left by n bits, wrapping truncated bits around to the right side of the resulting value.

If n is larger than the bitwidth of this number type, n is reduced mod that bitwidth. For example, rotating an i16 with n = 35 is equivalent to rotating with n = 3, since 35 = 3 mod 16.

pub fn rotate_right(self, n: u32) -> Self

Shifts right by n bits, wrapping truncated bits around to the left side of the resulting value.

If n is larger than the bitwidth of this number type, n is reduced mod that bitwidth. For example, rotating an i16 with n = 35 is equivalent to rotating with n = 3, since 35 = 3 mod 16.

pub fn expose(self) -> u16

Remove the timing protection and expose the raw number value. Once a value is exposed, it is the library user’s responsibility to prevent timing leaks (if necessary).

Commonly, this method is used when a value is safe to make public (e.g. when an encryption algorithm outputs a ciphertext). Alternatively, this method may need to be used when providing a secret value to an interface that does not use timing-shield’s types (e.g. writing a secret key to a file using a file system API).

Trait Implementations

impl Add<TpU16> for u16

type Output = TpU16

The resulting type after applying the + operator.

fn add(self, other: TpU16) -> TpU16

Performs the + operation.

impl Add<u16> for TpU16

type Output = TpU16

The resulting type after applying the + operator.

fn add(self, other: u16) -> TpU16

Performs the + operation.

impl Add for TpU16

type Output = TpU16

The resulting type after applying the + operator.

fn add(self, other: TpU16) -> TpU16

Performs the + operation.

impl AddAssign<u16> for TpU16

fn add_assign(&mut self, rhs: u16)

Performs the += operation.

impl AddAssign for TpU16

fn add_assign(&mut self, rhs: TpU16)

Performs the += operation.

impl BitAnd<TpU16> for u16

type Output = TpU16

The resulting type after applying the & operator.

fn bitand(self, other: TpU16) -> TpU16

Performs the & operation.

impl BitAnd<u16> for TpU16

type Output = TpU16

The resulting type after applying the & operator.

fn bitand(self, other: u16) -> TpU16

Performs the & operation.

impl BitAnd for TpU16

type Output = TpU16

The resulting type after applying the & operator.

fn bitand(self, other: TpU16) -> TpU16

Performs the & operation.

impl BitAndAssign<u16> for TpU16

fn bitand_assign(&mut self, rhs: u16)

Performs the &= operation.

impl BitAndAssign for TpU16

fn bitand_assign(&mut self, rhs: TpU16)

Performs the &= operation.

impl BitOr<TpU16> for u16

type Output = TpU16

The resulting type after applying the | operator.

fn bitor(self, other: TpU16) -> TpU16

Performs the | operation.

impl BitOr<u16> for TpU16

type Output = TpU16

The resulting type after applying the | operator.

fn bitor(self, other: u16) -> TpU16

Performs the | operation.

impl BitOr for TpU16

type Output = TpU16

The resulting type after applying the | operator.

fn bitor(self, other: TpU16) -> TpU16

Performs the | operation.

impl BitOrAssign<u16> for TpU16

fn bitor_assign(&mut self, rhs: u16)

Performs the |= operation.

impl BitOrAssign for TpU16

fn bitor_assign(&mut self, rhs: TpU16)

Performs the |= operation.

impl BitXor<TpU16> for u16

type Output = TpU16

The resulting type after applying the ^ operator.

fn bitxor(self, other: TpU16) -> TpU16

Performs the ^ operation.

impl BitXor<u16> for TpU16

type Output = TpU16

The resulting type after applying the ^ operator.

fn bitxor(self, other: u16) -> TpU16

Performs the ^ operation.

impl BitXor for TpU16

type Output = TpU16

The resulting type after applying the ^ operator.

fn bitxor(self, other: TpU16) -> TpU16

Performs the ^ operation.

impl BitXorAssign<u16> for TpU16

fn bitxor_assign(&mut self, rhs: u16)

Performs the ^= operation.

impl BitXorAssign for TpU16

fn bitxor_assign(&mut self, rhs: TpU16)

Performs the ^= operation.

impl Clone for TpU16

fn clone(&self) -> TpU16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Mul<TpU16> for u16

type Output = TpU16

The resulting type after applying the * operator.

fn mul(self, other: TpU16) -> TpU16

Performs the * operation.

impl Mul<u16> for TpU16

type Output = TpU16

The resulting type after applying the * operator.

fn mul(self, other: u16) -> TpU16

Performs the * operation.

impl Mul for TpU16

type Output = TpU16

The resulting type after applying the * operator.

fn mul(self, other: TpU16) -> TpU16

Performs the * operation.

impl MulAssign<u16> for TpU16

fn mul_assign(&mut self, rhs: u16)

Performs the *= operation.

impl MulAssign for TpU16

fn mul_assign(&mut self, rhs: TpU16)

Performs the *= operation.

impl Not for TpU16

type Output = TpU16

The resulting type after applying the ! operator.

fn not(self) -> TpU16

Performs the unary ! operation.

impl Shl<u32> for TpU16

type Output = TpU16

The resulting type after applying the << operator.

fn shl(self, other: u32) -> TpU16

Performs the << operation.

impl ShlAssign<u32> for TpU16

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl Shr<u32> for TpU16

type Output = TpU16

The resulting type after applying the >> operator.

fn shr(self, other: u32) -> TpU16

Performs the >> operation.

impl ShrAssign<u32> for TpU16

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl Sub<TpU16> for u16

type Output = TpU16

The resulting type after applying the - operator.

fn sub(self, other: TpU16) -> TpU16

Performs the - operation.

impl Sub<u16> for TpU16

type Output = TpU16

The resulting type after applying the - operator.

fn sub(self, other: u16) -> TpU16

Performs the - operation.

impl Sub for TpU16

type Output = TpU16

The resulting type after applying the - operator.

fn sub(self, other: TpU16) -> TpU16

Performs the - operation.

impl SubAssign<u16> for TpU16

fn sub_assign(&mut self, rhs: u16)

Performs the -= operation.

impl SubAssign for TpU16

fn sub_assign(&mut self, rhs: TpU16)

Performs the -= operation.

impl TpCondSwap for TpU16

fn tp_cond_swap(condition: TpBool, a: &mut TpU16, b: &mut TpU16)

Swap a and b if and only if condition is true.

impl TpEq<TpU16> for u16

fn tp_eq(&self, other: &TpU16) -> TpBool

Compare self with other for equality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_not_eq(&self, other: &TpU16) -> TpBool

Compare self with other for inequality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl TpEq<u16> for TpU16

fn tp_eq(&self, other: &u16) -> TpBool

Compare self with other for equality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_not_eq(&self, other: &u16) -> TpBool

Compare self with other for inequality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl TpEq for TpU16

fn tp_eq(&self, other: &TpU16) -> TpBool

Compare self with other for equality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_not_eq(&self, other: &TpU16) -> TpBool

Compare self with other for inequality without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl TpOrd<TpU16> for u16

fn tp_lt(&self, other: &TpU16) -> TpBool

Compute self < other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt(&self, other: &TpU16) -> TpBool

Compute self > other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_lt_eq(&self, other: &TpU16) -> TpBool

Compute self <= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt_eq(&self, other: &TpU16) -> TpBool

Compute self >= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl TpOrd<u16> for TpU16

fn tp_lt(&self, other: &u16) -> TpBool

Compute self < other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt(&self, other: &u16) -> TpBool

Compute self > other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_lt_eq(&self, other: &u16) -> TpBool

Compute self <= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt_eq(&self, other: &u16) -> TpBool

Compute self >= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl TpOrd for TpU16

fn tp_lt(&self, other: &TpU16) -> TpBool

Compute self < other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt(&self, other: &TpU16) -> TpBool

Compute self > other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_lt_eq(&self, other: &TpU16) -> TpBool

Compute self <= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

fn tp_gt_eq(&self, other: &TpU16) -> TpBool

Compute self >= other without leaking the result. Important: if either input is not a timing-protected type, this operation might leak the value of that type. To prevent timing leaks, protect values before performing any operations on them.

impl Copy for TpU16