module Net::IMAP::SASL::ProtocolAdapters::Generic - net-imap: Ruby Standard Library Documentation

# module Net::IMAP::SASL::ProtocolAdapters::Generic

See Interface at `SASL::ProtocolAdapters`.

### Public Instance Methods

cancel_response() click to toggle source

Returns the message used by the client to abort an authentication exchange.

The generic implementation returns `"*"`.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 73
    def cancel_response;  "*" end

command_name() click to toggle source

The name of the protocol command used to initiate a SASL authentication exchange.

The generic implementation returns `"AUTHENTICATE"`.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 44
    def command_name;     "AUTHENTICATE" end

decode(string) click to toggle source

Decodes a server challenge string.

The generic implementation returns the Base64 decoding of `string`.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 67
    def decode(string)    string.unpack1("m0") end

encode(string) click to toggle source

Encodes a client response string.

The generic implementation returns the Base64 encoding of `string`.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 62
    def encode(string)    [string].pack("m0") end

encode_ir(string) click to toggle source

Encodes an initial response string.

The generic implementation returns the result of `encode`, or returns `"="` when `string` is empty.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 57
    def encode_ir(string) string.empty? ? "=" : encode(string) end

service() click to toggle source

A service name from the GSSAPI/Kerberos/SASL Service Names registry.

The generic implementation returns `"host"`, which is the generic GSSAPI host-based service name.

    # File net-imap-0.5.4/lib/net/imap/sasl/protocol_adapters.rb, line 51
    def service;          "host" end