|
| 1 | +// Copyright (c) 2023 The MobileCoin Foundation |
| 2 | + |
| 3 | +//! # subtle |
| 4 | +//! |
| 5 | +//! [![Crates.io][crate-image]][crate-link]<!-- |
| 6 | +//! -->[![Docs Status][docs-image]][docs-link]<!-- |
| 7 | +//! |
| 8 | +//! **Procedural macros for deriving [subtle] trait implementations.** |
| 9 | +//! |
| 10 | +//! Derive macro implemented for traits: |
| 11 | +//! - [x] ConstantTimeEq |
| 12 | +//! - [ ] ConstantTimeGreater |
| 13 | +//! - [ ] ConstantTimeLesser |
| 14 | +//! |
| 15 | +//! ## Documentation |
| 16 | +//! |
| 17 | +//! Documentation is available [here][docs-link]. |
| 18 | +//! |
| 19 | +//! # Installation |
| 20 | +//! To install, add the following to the dependencies section of your project's `Cargo.toml`: |
| 21 | +//! |
| 22 | +//! ```toml |
| 23 | +//! subtle = { version = "2.6", features = ["derive"] } |
| 24 | +//! ``` |
| 25 | +//! |
| 26 | +//! ## Example |
| 27 | +//! |
| 28 | +//! ```rust |
| 29 | +//! use subtle_derive::ConstantTimeEq; |
| 30 | +//! use subtle::ConstantTimeEq; |
| 31 | +//! |
| 32 | +//! #[derive(ConstantTimeEq)] |
| 33 | +//! struct MyStruct { |
| 34 | +//! data: [u8; 16] |
| 35 | +//! } |
| 36 | +//! |
| 37 | +//! |
| 38 | +//! fn main() { |
| 39 | +//! let first = MyStruct { data: [1u8;16]}; |
| 40 | +//! let second = MyStruct { data: [1u8;16]}; |
| 41 | +//! |
| 42 | +//! assert!(bool::from(first.ct_eq(&second))); |
| 43 | +//! } |
| 44 | +//! ``` |
| 45 | +//! |
| 46 | +//! [crate-image]: https://img.shields.io/crates/v/subtle-derive?style=flat-square |
| 47 | +//! [crate-link]: https://crates.io/crates/subtle-derive |
| 48 | +//! [docs-image]: https://img.shields.io/docsrs/subtle-derive?style=flat-square |
| 49 | +//! [docs-link]: https://docs.rs/crate/subtle-derive |
| 50 | +//! [subtle]: https://crates.io/crates/subtle |
| 51 | +
|
| 52 | +use proc_macro::TokenStream; |
| 53 | +use quote::quote; |
| 54 | +use syn::{parse_macro_input, Data, DataEnum, DeriveInput, Fields, GenericParam, Generics}; |
| 55 | + |
| 56 | +#[proc_macro_derive(ConstantTimeEq)] |
| 57 | +pub fn constant_time_eq(input: TokenStream) -> TokenStream { |
| 58 | + let input = parse_macro_input!(input as DeriveInput); |
| 59 | + derive_ct_eq(&input) |
| 60 | +} |
| 61 | + |
| 62 | + |
| 63 | +fn parse_fields(fields: &Fields) -> Result<proc_macro2::TokenStream, &'static str> { |
| 64 | + match &fields { |
| 65 | + Fields::Named(fields_named) => { |
| 66 | + let mut token_stream = quote!(); |
| 67 | + let mut iter = fields_named.named.iter().peekable(); |
| 68 | + |
| 69 | + while let Some(field) = iter.next() { |
| 70 | + let ident = &field.ident; |
| 71 | + match iter.peek() { |
| 72 | + None => token_stream.extend(quote! { {self.#ident}.ct_eq(&{other.#ident}) }), |
| 73 | + Some(_) => { |
| 74 | + token_stream.extend(quote! { {self.#ident}.ct_eq(&{other.#ident}) & }) |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + Ok(token_stream) |
| 79 | + } |
| 80 | + Fields::Unnamed(unnamed_fields) => { |
| 81 | + let mut token_stream = quote!(); |
| 82 | + let mut iter = unnamed_fields.unnamed.iter().peekable(); |
| 83 | + let mut idx = 0; |
| 84 | + while let Some(_) = iter.next() { |
| 85 | + let i = syn::Index::from(idx); |
| 86 | + match iter.peek() { |
| 87 | + None => token_stream.extend(quote! { {self.#i}.ct_eq(&{other.#i}) }), |
| 88 | + Some(_) => { |
| 89 | + token_stream.extend(quote! { {self.#i}.ct_eq(&{other.#i}) & }); |
| 90 | + idx += 1; |
| 91 | + } |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + Ok(token_stream) |
| 96 | + } |
| 97 | + Fields::Unit => Err("Constant time cannot be derived for unit fields"), |
| 98 | + } |
| 99 | +} |
| 100 | + |
| 101 | +fn parse_enum(data_enum: &DataEnum) -> Result<proc_macro2::TokenStream, &'static str> { |
| 102 | + for variant in data_enum.variants.iter() { |
| 103 | + if let Fields::Unnamed(_) = variant.fields { |
| 104 | + panic!("Cannot derive ct_eq for fields in enums") |
| 105 | + } |
| 106 | + } |
| 107 | + let token_stream = quote! { |
| 108 | + ::subtle::Choice::from((self == other) as u8) |
| 109 | + }; |
| 110 | + |
| 111 | + Ok(token_stream) |
| 112 | +} |
| 113 | + |
| 114 | +fn parse_data(data: &Data) -> Result<proc_macro2::TokenStream, &'static str> { |
| 115 | + match data { |
| 116 | + Data::Struct(variant_data) => parse_fields(&variant_data.fields), |
| 117 | + Data::Enum(data_enum) => parse_enum(data_enum), |
| 118 | + Data::Union(..) => Err("Constant time cannot be derived for a union"), |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +fn parse_lifetime(generics: &Generics) -> u32 { |
| 123 | + let mut count = 0; |
| 124 | + for i in generics.params.iter() { |
| 125 | + if let GenericParam::Lifetime(_) = i { |
| 126 | + count += 1; |
| 127 | + } |
| 128 | + } |
| 129 | + count |
| 130 | +} |
| 131 | + |
| 132 | +fn derive_ct_eq(input: &DeriveInput) -> TokenStream { |
| 133 | + let ident = &input.ident; |
| 134 | + let data = &input.data; |
| 135 | + let generics = &input.generics; |
| 136 | + let is_lifetime = parse_lifetime(generics); |
| 137 | + let ct_eq_stream: proc_macro2::TokenStream = |
| 138 | + parse_data(data).expect("Failed to parse DeriveInput data"); |
| 139 | + let data_ident = if is_lifetime != 0 { |
| 140 | + let mut s = format!("{}<'_", ident); |
| 141 | + |
| 142 | + for _ in 1..is_lifetime { |
| 143 | + s.push_str(", '_"); |
| 144 | + } |
| 145 | + s.push('>'); |
| 146 | + |
| 147 | + s |
| 148 | + } else { |
| 149 | + ident.to_string() |
| 150 | + }; |
| 151 | + let ident_stream: proc_macro2::TokenStream = |
| 152 | + data_ident.parse().expect("Should be valid lifetime tokens"); |
| 153 | + |
| 154 | + let expanded: proc_macro2::TokenStream = quote! { |
| 155 | + impl ::subtle::ConstantTimeEq for #ident_stream { |
| 156 | + fn ct_eq(&self, other: &Self) -> ::subtle::Choice { |
| 157 | + use ::subtle::ConstantTimeEq; |
| 158 | + return #ct_eq_stream |
| 159 | + } |
| 160 | + } |
| 161 | + }; |
| 162 | + |
| 163 | + expanded.into() |
| 164 | +} |
0 commit comments