#[non_exhaustive]pub struct Config {
pub percent_encode: bool,
pub crypto_rules: Vec<CryptoRule>,
}
Expand description
Config
specifies how the server should handle incoming and outgoing cookies
with respect to security and encoding.
In particular, it specifies whether cookie values and names should be percent-encoded, and whether cookie values should be encrypted or signed.
Check out the documentation for the fields of this struct for more information.
§Processor
To action the rules specified in this struct, you must convert it into a Processor
:
use biscotti::{Processor, Key};
use biscotti::config::{Config, CryptoRule, CryptoType};
let mut config = Config::default();
config.crypto_rules.push(CryptoRule {
cookie_names: vec!["session".to_string()],
r#type: CryptoType::Encryption,
// You'll use a key loaded from *somewhere* in production—e.g.
// from a file, environment variable, or a secret management service.
key: Key::generate(),
secondary_keys: vec![],
});
let processor: Processor = config.into();
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.percent_encode: bool
If true
, all cookie values and names are automatically:
- percent-decoded, when parsing request cookies out of the
Cookie
header. - percent-encoded, when building the
Set-Cookie
header from response cookies.
If false
, cookie values and names are used as is.
By default, this field is true
.
crypto_rules: Vec<CryptoRule>
By default:
- Values for response cookies are sent to the client unencrypted and unsigned
- Values for request cookies are assumed to be unencrypted and unsigned
You can opt into higher cryptographic guarantees for specific cookies using
one or more CryptoRule
s.
Trait Implementations§
source§impl<'de> Deserialize<'de> for Config
impl<'de> Deserialize<'de> for Config
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more