身份验证系统 ¶

aiosmtpd provides a framework for SMTP Authentication that fully complies with RFC 4954 .

激活身份验证 ¶

aiosmtpd authentication is always activated, but attempts to authenticate will always be rejected unless the authenticator 参数对于 SMTP is set to a valid & working Authenticator Callback .

AUTH API ¶

aiosmtpd Authentication Framework comprises several components, who are collectivelly called the “AUTH API”.

AUTH Handler Hook ¶

async handle_AUTH ( server : SMTP , session : Session , envelope : Envelope , args ) ¶

AUTH Mechanism Hooks ¶

Separately from AUTH Handler Hook , aiosmtpd also implement support for “AUTH Mechanism Hooks”. These async hooks will implement the logic for SMTP Authentication Mechanisms.

Every AUTH Mechanism Hook is named auth_MECHANISM where MECHANISM is the all-uppercase name of the mechanism that the hook will implement.

(Mechanism is the word following the AUTH command sent by client.)

重要

若 MECHANISM has a dash within its name, use double-underscore to represent the dash. For example, to implement a MECH-WITH-DASHES mechanism, name the AUTH hook as auth_MECH__WITH__DASHES .

Single underscores will not be modified. So a hook named auth_MECH_WITH_UNDERSCORE will implement the MECH_WITH_UNDERSCORE 机制。

(If in the future a SASL mechanism with double underscores in its name gets defined, this name-mangling mechanism will be revisited. That is very unlikely to happen, though.)

Alternatively, you can also use the auth_mechanism() decorator, which you can import from the aiosmtpd.smtp 模块。

The SMTP class provides built-in AUTH hooks for the LOGIN and PLAIN mechanisms, named auth_LOGIN and auth_PLAIN , respectively. If the handler class implements auth_LOGIN and/or auth_PLAIN , then the methods of the handler instance will override the built-in methods.

async auth_MECHANISM ( server : SMTP , args : List [ str ] ) → aiosmtpd.smtp.AuthResult ¶

参数

server – The instance of the SMTP class invoking the AUTH Mechanism hook
args – A list of string split from the characters following the AUTH 命令。 args[0] is usually equal to MECHANISM (unless the auth_mechanism() decorator has been used).

The AUTH hook MUST perform the actual validation of AUTH credentials.

In the built-in AUTH hooks, this is done by invoking the function specified by the authenticator initialization argument.

AUTH Mechanism Hooks in handlers are NOT required to do the same, and MAY implement their own authenticator system.

The AUTH Mechanism Hook MUST return an instance of AuthResult containing the result of the Authentication process.

重要

定义 additional AUTH hooks in your handler will NOT disable the built-in LOGIN and PLAIN hooks; if you do not want to offer the LOGIN and PLAIN mechanisms, specify them in the auth_exclude_mechanism 参数为 SMTP 类。

Authenticator Callback ¶

Authenticator ( server , session , envelope , mechanism , auth_data ) → AuthResult ¶

参数

server – The SMTP instance that invoked the authenticator
session – A Session instance containing session data so far
envelope – An Envelope instance containing transaction data so far
mechanism ( str ) – name of the AUTH Mechanism chosen by the client
auth_data – A data structure containing authentication data gathered by the AUTH Mechanism

返回

Result of authentication

返回类型

AuthResult

This function would be invoked during or at the end of an Authentication Process by AUTH Mechanisms. Based on mechanism and auth_data , this function should return a decision on whether Authentication has been successful or not.

This function SHOULD NOT modify the attributes of session and envelope .

The type and contents of the auth_data parameter is wholly at the discretion of the calling AUTH Mechanism. For the built-in LOGIN and PLAIN Mechanisms, the type of data will be aiosmtpd.smtp.LoginPassword

New in version 1.3.

AuthResult API ¶

class AuthResult ( * , success , handled , message , auth_data ) ¶