1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
use std::{fmt, ops}; #[repr(transparent)] #[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Hash, Default)] pub struct Secret<T>(T); impl<T> From<T> for Secret<T> { fn from(t: T) -> Self { Self(t) } } impl<T> Secret<T> { pub fn inner(self) -> T { self.0 } } impl<T> ops::Deref for Secret<T> { type Target = T; fn deref(&self) -> &Self::Target { &self.0 } } impl<T> ops::DerefMut for Secret<T> { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl<T> fmt::Debug for Secret<T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "<hidden>") } } impl<T> fmt::Display for Secret<T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "<hidden>") } } #[cfg(feature = "serde")] mod serde { use serde::{Deserialize, Deserializer, Serialize, Serializer}; use super::Secret; impl<'de, T: Deserialize<'de>> Deserialize<'de> for Secret<T> { fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>, { T::deserialize(deserializer).map(Self) } } impl<T: Serialize> Serialize for super::Secret<T> { fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer, { serializer.serialize_str("<hidden>") } } pub fn insecure_serialize<T: Serialize, S>(x: &Secret<T>, s: S) -> Result<S::Ok, S::Error> where S: Serializer, { x.0.serialize(s) } } #[cfg(feature = "serde")] pub use self::serde::insecure_serialize; #[cfg(test)] mod tests { use super::*; #[cfg(feature = "serde")] #[test] fn test_insecure_serialize() { use serde_test::{assert_tokens, Token}; #[derive(::serde::Serialize, ::serde::Deserialize, PartialEq, Debug)] struct X { #[serde(serialize_with = "insecure_serialize")] y: Secret<u32>, } let x = X { y: Secret(1) }; assert_tokens( &x, &[ Token::Struct { name: "X", len: 1 }, Token::Str("y"), Token::U32(1), Token::StructEnd, ], ); } #[cfg(feature = "serde")] #[test] fn test_secure_serialize() { use serde_test::{assert_de_tokens, assert_ser_tokens, Token}; #[derive(::serde::Serialize, ::serde::Deserialize, PartialEq, Debug)] struct X { z: Secret<u32>, } let x = X { z: Secret(1) }; assert_ser_tokens( &x, &[ Token::Struct { name: "X", len: 1 }, Token::Str("z"), Token::Str("<hidden>"), Token::StructEnd, ], ); assert_de_tokens( &x, &[ Token::Struct { name: "X", len: 1 }, Token::Str("z"), Token::U32(1), Token::StructEnd, ], ); } }