Packages

quic

1.4.2
1.7.1 1.7.0 1.6.5 1.6.4 1.6.3 1.6.2 1.6.1 1.6.0 1.5.0 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.0 1.0.2 1.0.1 1.0.0 0.11.0 0.10.2 0.10.1 0.10.0 0.9.0 0.7.1 0.7.0 0.6.5 0.6.1 0.6.0 0.5.1 0.5.0

Pure Erlang QUIC implementation (RFC 9000)

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
36 Versions
0 Dependencies
Dependants
1 Advisory
Files
Activity
quic src dist quic_dist_auth.erl
Raw

src/dist/quic_dist_auth.erl 

%%% -*- erlang -*-

%%%

%%% QUIC Distribution Authentication Behaviour

%%%

%%% Copyright (c) 2024-2026 Benoit Chesneau

%%% Apache License 2.0

%%%

%%% @doc Optional authentication callback invoked between the QUIC

%%% handshake and the Erlang distribution handshake.

%%%

%%% Configure via the `auth_callback' option (sys.config or

%%% `-quic_dist auth_callback Mod:Fun'):

%%%

%%% ```

%%% {quic, [{dist, [

%%%   {auth_callback, {my_app_auth, authenticate}},

%%%   {auth_handshake_timeout, 10000}

%%% ]}]}.

%%% '''

%%%

%%% The callback runs on both sides. It can refuse the connection by

%%% returning `{error, Reason}'; the connection is then closed and the

%%% dist controller is never started.

%%%

%%% @end



-module(quic_dist_auth).



%% Implementations validate the freshly-established QUIC connection

%% (e.g. inspect peer certificates, run a challenge/response on a user

%% stream) and return `{ok, Info}' on success or `{error, Reason}' to

%% refuse it. `Timeout' is the deadline configured via

%% `auth_handshake_timeout'.

-callback authenticate(

    Conn :: pid(),

    Side :: client | server,

    Timeout :: timeout()

) ->

    {ok, Info :: term()} | {error, Reason :: term()}.