fe2o3_amqp_types/sasl/

mod.rs

//! Types defined in AMQP 1.0 specification Part 5.3: SASL

use serde_amqp::{
    primitives::{Array, Binary, Symbol},
    DeserializeComposite, SerializeComposite,
};
use serde_repr::{Deserialize_repr, Serialize_repr};

mod mechanisms;

/// 5.3.3.1 SASL Mechanisms
/// Advertise available sasl mechanisms.
/// <type name="sasl-mechanisms" class="composite" source="list" provides="sasl-frame">
///     <descriptor name="amqp:sasl-mechanisms:list" code="0x00000000:0x00000040"/>
///     <field name="sasl-server-mechanisms" type="symbol" multiple="true" mandatory="true"/>
/// </type>
/// Advertises the available SASL mechanisms that can be used for authentication.
///
/// NOTE: Serialize and Deserialize are manually implemented because
/// > A field which is defined as both multiple and mandatory MUST contain at least one value
/// > (i.e. for such a field both null and an array with no entries are invalid).
#[derive(Debug, Clone)]
pub struct SaslMechanisms {
    /// sasl-server-mechanisms supported sasl mechanisms
    ///
    /// A list of the sasl security mechanisms supported by the sending peer. It is invalid for
    /// this list to be null or empty. If the sending peer does not require its partner to
    /// authenticate with it, then it SHOULD send a list of one element with its value as the
    /// SASL mechanism ANONYMOUS. The server mechanisms are ordered in decreasing level of
    /// preference.
    pub sasl_server_mechanisms: Array<Symbol>,
}

/// 5.3.3.2 SASL Init
/// Initiate sasl exchange.
/// <type name="sasl-init" class="composite" source="list" provides="sasl-frame">
///     <descriptor name="amqp:sasl-init:list" code="0x00000000:0x00000041"/>
///     <field name="mechanism" type="symbol" mandatory="true"/>
///     <field name="initial-response" type="binary"/>
///     <field name="hostname" type="string"/>
/// </type>
/// Selects the sasl mechanism and provides the initial response if needed.
#[derive(Debug, Clone, SerializeComposite, DeserializeComposite)]
#[amqp_contract(
    name = "amqp:sasl-init:list",
    code = "0x0000_0000:0x0000_0041",
    encoding = "list",
    rename_all = "kebab-case"
)]
pub struct SaslInit {
    /// selected security mechanism
    ///
    /// The name of the SASL mechanism used for the SASL exchange. If the selected mechanism is
    /// not supported by the receiving peer, it MUST close the connection with the authentication-failure
    /// close-code. Each peer MUST authenticate using the highest-level security profile it can handle
    /// from the list provided by the partner
    pub mechanism: Symbol,

    /// security response data
    ///
    /// A block of opaque data passed to the security mechanism. The contents of this data are defined
    /// by the SASL security mechanism.
    pub initial_response: Option<Binary>,

    /// the name of the target host
    ///
    /// The DNS name of the host (either fully qualified or relative) to which the sending peer is connecting.
    /// It is not mandatory to provide the hostname. If no hostname is provided the receiving peer
    /// SHOULD select a default based on its own configuration.
    /// This field can be used by AMQP proxies to determine the correct back-end service to connect the
    /// client to, and to determine the domain to validate the client’s credentials against.
    /// This field might already have been specified by the server name indication extension as described
    /// in RFC-4366 \[RFC4366\], if a TLS layer is used, in which case this field SHOULD either be null or
    /// contain the same value. It is undefined what a different value to those already specified means.
    pub hostname: Option<String>,
}

/// 5.3.3.3 SASL Challenge
/// Security mechanism challenge.
/// <type name="sasl-challenge" class="composite" source="list" provides="sasl-frame">
///     <descriptor name="amqp:sasl-challenge:list" code="0x00000000:0x00000042"/>
///     <field name="challenge" type="binary" mandatory="true"/>
/// </type>
/// Send the SASL challenge data as defined by the SASL specification.
#[derive(Debug, Clone, SerializeComposite, DeserializeComposite)]
#[amqp_contract(
    name = "amqp:sasl-challenge:list",
    code = "0x0000_0000:0x0000_0042",
    encoding = "list",
    rename_all = "kebab-case"
)]
pub struct SaslChallenge {
    /// <field name="challenge" type="binary" mandatory="true"/>
    pub challenge: Binary,
}

/// 5.3.3.4 SASL Response
/// Security mechanism response.
/// <type name="sasl-response" class="composite" source="list" provides="sasl-frame">
///     <descriptor name="amqp:sasl-response:list" code="0x00000000:0x00000043"/>
///     <field name="response" type="binary" mandatory="true"/>
/// </type>
/// Send the SASL response data as defined by the SASL specification.
#[derive(Debug, Clone, SerializeComposite, DeserializeComposite)]
#[amqp_contract(
    name = "amqp:sasl-response:list",
    code = "0x0000_0000:0x0000_0043",
    encoding = "list",
    rename_all = "kebab-case"
)]
pub struct SaslResponse {
    /// <field name="response" type="binary" mandatory="true"/>
    pub response: Binary,
}

/// 5.3.3.5 SASL Outcome
/// Indicates the outcome of the sasl dialog.
/// <type name="sasl-outcome" class="composite" source="list" provides="sasl-frame">
///     <descriptor name="amqp:sasl-outcome:list" code="0x00000000:0x00000044"/>
///     <field name="code" type="sasl-code" mandatory="true"/>
///     <field name="additional-data" type="binary"/>
/// </type>
/// This frame indicates the outcome of the SASL dialog. Upon successful completion of the SASL
/// dialog the security layer has been established, and the peers MUST exchange protocol headers
/// to either start a nested security layer, or to establish the AMQP connection.
#[derive(Debug, Clone, SerializeComposite, DeserializeComposite)]
#[amqp_contract(
    name = "amqp:sasl-outcome:list",
    code = "0x0000_0000:0x0000_0044",
    encoding = "list",
    rename_all = "kebab-case"
)]
pub struct SaslOutcome {
    /// <field name="code" type="sasl-code" mandatory="true"/>
    pub code: SaslCode,
    /// <field name="additional-data" type="binary"/>
    pub additional_data: Option<Binary>,
}

/// 5.3.3.6 SASL Code
/// Codes to indicate the outcome of the sasl dialog.
/// <type name="sasl-code" class="restricted" source="ubyte">
///     <choice name="ok" value="0"/>
///     <choice name="auth" value="1"/>
///     <choice name="sys" value="2"/>
///     <choice name="sys-perm" value="3"/>
///     <choice name="sys-temp" value="4"/>
/// </type>
#[derive(Debug, Clone, Serialize_repr, Deserialize_repr, PartialEq, Eq)]
#[repr(u8)]
pub enum SaslCode {
    /// 0 Connection authentication succeeded.
    Ok = 0u8,
    /// 1 Connection authentication failed due to an unspecified problem with the supplied
    /// credentials.
    Auth = 1,
    /// 2 Connection authentication failed due to a system error.
    Sys = 2,
    /// 3 Connection authentication failed due to a system error that is unlikely to be corrected without intervention.
    SysPerm = 3,
    /// 4 Connection authentication failed due to a transient system error.
    SysTemp = 4,
}

pub mod constant {
    //! Constans definedin AMQP 1.0 specification Part 5.3.4

    ///  major protocol version
    pub const SASL_MAJOR: u8 = 1;

    /// minor protocol version.
    pub const SASL_MINOR: u8 = 0;

    /// protocol revision.
    pub const SASL_REVISION: u8 = 0;
}

#[cfg(test)]
mod tests {
    use serde_amqp::{format_code::EncodingCodes, from_slice, to_vec};

    use super::SaslCode;

    fn assert_eq_on_sasl_code_and_deserialized(code: SaslCode, buf: Vec<u8>) {
        let deserialized: SaslCode = from_slice(&buf).unwrap();
        assert_eq!(code, deserialized);
    }

    #[test]
    fn test_serialize_deserialize_sasl_code() {
        let code = SaslCode::Ok;
        let buf = to_vec(&code).unwrap();
        let expected = vec![EncodingCodes::Ubyte as u8, code.clone() as u8];
        assert_eq!(&buf, &expected);
        assert_eq_on_sasl_code_and_deserialized(code, expected);

        let code = SaslCode::Auth;
        let buf = to_vec(&code).unwrap();
        let expected = vec![EncodingCodes::Ubyte as u8, code.clone() as u8];
        assert_eq!(&buf, &expected);
        assert_eq_on_sasl_code_and_deserialized(code, expected);

        let code = SaslCode::Sys;
        let buf = to_vec(&code).unwrap();
        let expected = vec![EncodingCodes::Ubyte as u8, code.clone() as u8];
        assert_eq!(&buf, &expected);
        assert_eq_on_sasl_code_and_deserialized(code, expected);

        let code = SaslCode::SysPerm;
        let buf = to_vec(&code).unwrap();
        let expected = vec![EncodingCodes::Ubyte as u8, code.clone() as u8];
        assert_eq!(&buf, &expected);
        assert_eq_on_sasl_code_and_deserialized(code, expected);

        let code = SaslCode::SysTemp;
        let buf = to_vec(&code).unwrap();
        let expected = vec![EncodingCodes::Ubyte as u8, code.clone() as u8];
        assert_eq!(&buf, &expected);
        assert_eq_on_sasl_code_and_deserialized(code, expected);
    }
}