Module escalus_auth

Module supporting various authentication mechanisms.

Copyright © (C) 2012, Erlang Solutions Ltd.

Description

Module supporting various authentication mechanisms

Data Types

client()

client() = escalus_connection:client()

hash_type()

hash_type() = fast_scram:sha_type()

plus_variant()

plus_variant() = undefined | none | tls_exporter

scram_options()

scram_options() = #{plus_variant := plus_variant(), hash_type := hash_type(), xmpp_method := binary()}

user_spec()

user_spec() = escalus_users:user_spec()

Function Index

auth_digest_md5/2
auth_plain/2
auth_sasl_anon/2
auth_sasl_external/2
auth_sasl_oauth/2
auth_sasl_scram/3
auth_sasl_scram_sha1/2
auth_sasl_scram_sha1_plus/2
auth_sasl_scram_sha224/2
auth_sasl_scram_sha224_plus/2
auth_sasl_scram_sha256/2
auth_sasl_scram_sha256_plus/2
auth_sasl_scram_sha384/2
auth_sasl_scram_sha384_plus/2
auth_sasl_scram_sha3_224/2
auth_sasl_scram_sha3_224_plus/2
auth_sasl_scram_sha3_256/2
auth_sasl_scram_sha3_256_plus/2
auth_sasl_scram_sha3_384/2
auth_sasl_scram_sha3_384_plus/2
auth_sasl_scram_sha3_512/2
auth_sasl_scram_sha3_512_plus/2
auth_sasl_scram_sha512/2
auth_sasl_scram_sha512_plus/2
get_challenge/2
wait_for_success/2

Function Details

auth_digest_md5/2

auth_digest_md5(Conn::client(), Props::user_spec()) -> ok

auth_plain/2

auth_plain(Conn::client(), Props::user_spec()) -> ok

auth_sasl_anon/2

auth_sasl_anon(Conn::client(), Props::user_spec()) -> ok

auth_sasl_external/2

auth_sasl_external(Conn::client(), Props::user_spec()) -> ok

auth_sasl_oauth/2

auth_sasl_oauth(Conn::client(), Props::user_spec()) -> {ok, user_spec()}

auth_sasl_scram/3

auth_sasl_scram(X1::scram_options(), Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha1/2

auth_sasl_scram_sha1(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha1_plus/2

auth_sasl_scram_sha1_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha224/2

auth_sasl_scram_sha224(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha224_plus/2

auth_sasl_scram_sha224_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha256/2

auth_sasl_scram_sha256(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha256_plus/2

auth_sasl_scram_sha256_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha384/2

auth_sasl_scram_sha384(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha384_plus/2

auth_sasl_scram_sha384_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_224/2

auth_sasl_scram_sha3_224(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_224_plus/2

auth_sasl_scram_sha3_224_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_256/2

auth_sasl_scram_sha3_256(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_256_plus/2

auth_sasl_scram_sha3_256_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_384/2

auth_sasl_scram_sha3_384(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_384_plus/2

auth_sasl_scram_sha3_384_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_512/2

auth_sasl_scram_sha3_512(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha3_512_plus/2

auth_sasl_scram_sha3_512_plus(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha512/2

auth_sasl_scram_sha512(Conn::client(), Props::user_spec()) -> ok

auth_sasl_scram_sha512_plus/2

auth_sasl_scram_sha512_plus(Conn::client(), Props::user_spec()) -> ok

get_challenge/2

get_challenge(Conn::client(), Descr::atom()) -> [{binary(), binary()}]

wait_for_success/2

wait_for_success(Username::any(), Conn::client()) -> ok


Generated by EDoc