Struct SecuritySchemeBuilder

pub struct SecuritySchemeBuilder<S> { /* private fields */ }

Builder for the Security Scheme

Implementations

impl SecuritySchemeBuilder<()>

pub fn no_sec(self) -> SecuritySchemeBuilder<SecuritySchemeNoSecTag>

Default no-security scheme

pub fn auto(self) -> SecuritySchemeBuilder<SecuritySchemeAutoTag>

Auto security scheme

pub fn combo(self) -> SecuritySchemeBuilder<EmptyComboSecuritySchemeTag>

Combo security scheme

pub fn basic(self) -> SecuritySchemeBuilder<BasicSecurityScheme>

Basic Authentication RFC7617

pub fn digest(self) -> SecuritySchemeBuilder<DigestSecurityScheme>

Digest Assess Authentication RFC7616

pub fn bearer(self) -> SecuritySchemeBuilder<BearerSecurityScheme>

Bearer Token RFC6750

pub fn psk(self) -> SecuritySchemeBuilder<PskSecurityScheme>

Pre-shared key authentication

pub fn oauth2( self, flow: impl Into<String>, ) -> SecuritySchemeBuilder<OAuth2SecurityScheme>

OAuth2 authentication RFC6749 and RFC8252

pub fn apikey(self) -> SecuritySchemeBuilder<ApiKeySecurityScheme>

API key authentication

pub fn custom( self, scheme: impl Into<String>, ) -> SecuritySchemeBuilder<UnknownSecuritySchemeSubtype>

Security scheme defined by an additional Vocabulary

NOTE: Its definition MUST be in the Thing @context.

impl<T> SecuritySchemeBuilder<T>

pub fn description(self, value: impl Into<String>) -> SecuritySchemeBuilder<T>

Sets the value of the description field.

pub fn proxy(self, value: impl Into<String>) -> SecuritySchemeBuilder<T>

Sets the value of the proxy field.

pub fn attype(self, ty: impl Into<String>) -> SecuritySchemeBuilder<T>

JSON-LD @type

pub fn descriptions<F>(self, f: F) -> SecuritySchemeBuilder<T>

where F: FnOnce(&mut MultiLanguageBuilder<String>) -> &mut MultiLanguageBuilder<String>,

Multi-language descriptions

See ThingBuilder::titles for examples.

pub fn with_key(self, name: impl Into<String>) -> SecuritySchemeBuilder<T>

Sets the key to be used for referring to the security scheme in the Thing::security and Form::security fields.

pub fn required(self) -> SecuritySchemeBuilder<T>

Makes the security scheme required.

impl<T> SecuritySchemeBuilder<T>

where T: HasNameLocation,

pub fn name(self, value: impl Into<String>) -> SecuritySchemeBuilder<T>

Name for query, header or cookie parameter

pub fn location( self, value: SecurityAuthenticationLocation, ) -> SecuritySchemeBuilder<T>

Location of the security authentication information

impl SecuritySchemeBuilder<EmptyComboSecuritySchemeTag>

pub fn all_of<I, T>( self, iter: I, ) -> SecuritySchemeBuilder<(AllOfComboSecuritySchemeTag, Vec<String>)>

where I: IntoIterator<Item = T>, T: Into<String>,

Require all the specified schema definitions for the security combo.

Examples

let thing = Thing::builder("Thing name")
    .finish_extend()
    .security(|builder| builder.combo().all_of(["basic", "nosec"]))
    .security(|builder| builder.basic())
    .security(|builder| builder.no_sec())
    .build()
    .unwrap();

assert_eq!(
    serde_json::to_value(thing).unwrap(),
    json!({
        "title": "Thing name",
        "@context": "https://www.w3.org/2022/wot/td/v1.1",
        "security": [],
        "securityDefinitions": {
            "combo": {
                "scheme": "combo",
                "allOf": ["basic", "nosec"],
            },
            "basic": {
                "scheme": "basic",
                "in": "header",
            },
            "nosec": {
                "scheme": "nosec",
            },
        },
    })
);

If one the security identifier specified in .all_of does not exist across other security definitions, Thing::build returns an error:

let error = Thing::builder("Thing name")
    .finish_extend()
    .security(|builder| builder.combo().all_of(["basic", "nosec"]))
    .security(|builder| builder.no_sec())
    .build()
    .unwrap_err();

assert_eq!(error, Error::MissingSchemaDefinition("basic".to_string()));

pub fn one_of<I, T>( self, iter: I, ) -> SecuritySchemeBuilder<(OneOfComboSecuritySchemeTag, Vec<String>)>

where I: IntoIterator<Item = T>, T: Into<String>,

Require one of the specified schema definitions for the security combo.

Examples

let thing = Thing::builder("Thing name")
    .finish_extend()
    .security(|builder| builder.combo().one_of(["basic", "nosec"]))
    .security(|builder| builder.basic())
    .security(|builder| builder.no_sec())
    .build()
    .unwrap();

assert_eq!(
    serde_json::to_value(thing).unwrap(),
    json!({
        "title": "Thing name",
        "@context": "https://www.w3.org/2022/wot/td/v1.1",
        "security": [],
        "securityDefinitions": {
            "combo": {
                "scheme": "combo",
                "oneOf": ["basic", "nosec"],
            },
            "basic": {
                "scheme": "basic",
                "in": "header",
            },
            "nosec": {
                "scheme": "nosec",
            },
        },
    })
);

If one the security identifier specified in .one_of does not exist across other security definitions, Thing::build returns an error:

let error = Thing::builder("Thing name")
    .finish_extend()
    .security(|builder| builder.combo().one_of(["basic", "nosec"]))
    .security(|builder| builder.no_sec())
    .build()
    .unwrap_err();

assert_eq!(error, Error::MissingSchemaDefinition("basic".to_string()));

pub fn name( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<EmptyComboSecuritySchemeTag>

Name for query, header or cookie parameter

impl<T> SecuritySchemeBuilder<(T, Vec<String>)>

pub fn extend<I, U>(self, iter: I) -> SecuritySchemeBuilder<(T, Vec<String>)>

where I: IntoIterator<Item = U>, U: Into<String>,

Extends the security scheme subtype with a variable amount of items.

This is useful for combo security schemes, which require a set of names as references.

pub fn push( self, security_name: impl Into<String>, ) -> SecuritySchemeBuilder<(T, Vec<String>)>

Extends the security scheme subtype with an items.

This is useful for combo security schemes, which require a set of names as references.

pub fn name( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<(T, Vec<String>)>

Name for query, header or cookie parameter

impl SecuritySchemeBuilder<DigestSecurityScheme>

pub fn qop( self, value: QualityOfProtection, ) -> SecuritySchemeBuilder<DigestSecurityScheme>

Quality of protection

impl SecuritySchemeBuilder<BearerSecurityScheme>

pub fn authorization( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<BearerSecurityScheme>

URI of the authorization server

pub fn alg( self, value: impl Into<Cow<'static, str>>, ) -> SecuritySchemeBuilder<BearerSecurityScheme>

Encoding, encryption or digest algorithm

pub fn format( self, value: impl Into<Cow<'static, str>>, ) -> SecuritySchemeBuilder<BearerSecurityScheme>

Format of the security authentication information

impl SecuritySchemeBuilder<OAuth2SecurityScheme>

pub fn authorization( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<OAuth2SecurityScheme>

URI of the authorization server

pub fn token( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<OAuth2SecurityScheme>

URI of the token server

pub fn refresh( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<OAuth2SecurityScheme>

URI of the refresh server

pub fn scope( self, value: impl Into<String>, ) -> SecuritySchemeBuilder<OAuth2SecurityScheme>

Authorization scope identifier

impl SecuritySchemeBuilder<UnknownSecuritySchemeSubtype>

pub fn data( self, value: impl Into<Value>, ) -> SecuritySchemeBuilder<UnknownSecuritySchemeSubtype>

JSON Value to be merged into the Scheme