o
    b&0                     @   s   d Z ddlmZ ddlmZ ddlmZmZ ddlm	Z	 ddl
mZmZ ddlmZmZmZ ddlmZ eejG d	d
 d
ZG dd deZG dd deZG dd dejZG dd deZG dd dejZG dd dejZdS )z
Mail protocol support.
    )implementer)longversion)CramMD5CredentialsUsernamePassword)UnauthorizedLogin)deferprotocol)pop3relaysmtp)logc                   @   sH   e Zd ZU dZdZdZeed< ej	fddZ
dd Zd	d
 Zdd ZdS )DomainDeliveryBaseaN  
    A base class for message delivery using the domains of a mail service.

    @ivar service: See L{__init__}
    @ivar user: See L{__init__}
    @ivar host: See L{__init__}

    @type protocolName: L{bytes}
    @ivar protocolName: The protocol being used to deliver the mail.
        Sub-classes should set this appropriately.
    Ns   not-implemented-protocolprotocolNamec                 C   s   || _ || _|| _dS )z
        @type service: L{MailService}
        @param service: A mail service.

        @type user: L{bytes} or L{None}
        @param user: The authenticated SMTP user.

        @type host: L{bytes}
        @param host: The hostname.
        N)serviceuserhost)selfr   r   r    r   8/usr/lib/python3/dist-packages/twisted/mail/protocols.py__init__%   s   
zDomainDeliveryBase.__init__c           	      C   s   d }}| j rd| j d }|d rd|d  }d|d  d |d  d	 | | }d
| j d | j d td d }ddtt| d t	  }d| d | d | S )a  
        Generate a received header string for a message.

        @type helo: 2-L{tuple} of (L{bytes}, L{bytes})
        @param helo: The client's identity as sent in the HELO command and its
            IP address.

        @type origin: L{Address}
        @param origin: The origination address of the message.

        @type recipients: L{list} of L{User}
        @param recipients: The destination addresses for the message.

        @rtype: L{bytes}
        @return: A received header string.
            s    auth=xtextr   s    helo=s   from s    ([      ]s   by s    with s    (ascii   )s   for <    s   > s
   Received: s   
	)
r   encoder   r   r   joinmapbytesr   
rfc822date)	r   heloorigin
recipientsauthStrheloStrfromUserbyforUserr   r   r   receivedHeader4   s.   $
z!DomainDeliveryBase.receivedHeaderc                 C   sX   | j r| jjr| jj|jjd}|du rt| jd}n| jj|jj }t	
|j|S )a9  
        Validate the address for which a message is destined.

        @type user: L{User}
        @param user: The destination address.

        @rtype: L{Deferred <defer.Deferred>} which successfully fires with
            no-argument callable which returns L{IMessage <smtp.IMessage>}
            provider.
        @return: A deferred which successfully fires with a no-argument
            callable which returns a message receiver for the destination.

        @raise SMTPBadRcpt: When messages cannot be accepted for the
            destination address.
        NT)r   r   queuedomainsgetdestdomainr
   DomainQueuerr   maybeDeferredexists)r   r   dr   r   r   
validateToY   s   zDomainDeliveryBase.validateToc                 C   s8   |s	t |dd|jdkr|jdkrt |dd|S )a  
        Validate the address from which a message originates.

        @type helo: 2-L{tuple} of (L{bytes}, L{bytes})
        @param helo: The client's identity as sent in the HELO command and its
            IP address.

        @type origin: L{Address}
        @param origin: The origination address of the message.

        @rtype: L{Address}
        @return: The origination address.

        @raise SMTPBadSender: When messages cannot be accepted from the
            origination address.
        i  zWho are you?  Say HELO first.r   i  z#Sender address must contain domain.)r   SMTPBadSenderlocalr/   )r   r"   r#   r   r   r   validateFromr   s
   zDomainDeliveryBase.validateFrom)__name__
__module____qualname____doc__r   r   r    __annotations__r   DNSNAMEr   r*   r4   r7   r   r   r   r   r      s   
 %r   c                   @      e Zd ZdZdZdS )SMTPDomainDeliveryzA
    A domain delivery base class for use in an SMTP server.
    s   smtpNr8   r9   r:   r;   r   r   r   r   r   r?          r?   c                   @   r>   )ESMTPDomainDeliveryzB
    A domain delivery base class for use in an ESMTP server.
    s   esmtpNr@   r   r   r   r   rB      rA   rB   c                   @   s,   e Zd ZdZejZdZdddZdd Z	dS )SMTPFactorya;  
    An SMTP server protocol factory.

    @ivar service: See L{__init__}
    @ivar portal: See L{__init__}

    @type protocol: no-argument callable which returns a L{Protocol
        <protocol.Protocol>} subclass
    @ivar protocol: A callable which creates a protocol.  The default value is
        L{SMTP}.
    Nc                 C   s   t j|  || _|| _dS )z
        @type service: L{MailService}
        @param service: An email service.

        @type portal: L{Portal <twisted.cred.portal.Portal>} or
            L{None}
        @param portal: A portal to use for authentication.
        N)r   rC   r   r   portal)r   r   rD   r   r   r   r      s   	
zSMTPFactory.__init__c                 C   s2   t d|  tj| |}| j|_| j|_|S )a  
        Create an instance of an SMTP server protocol.

        @type addr: L{IAddress <twisted.internet.interfaces.IAddress>} provider
        @param addr: The address of the SMTP client.

        @rtype: L{SMTP}
        @return: An SMTP protocol.
        zConnection from )r   msgr   rC   buildProtocolr   rD   r   addrpr   r   r   rF      s
   
zSMTPFactory.buildProtocol)N)
r8   r9   r:   r;   r   SMTPr   rD   r   rF   r   r   r   r   rC      s    
rC   c                   @   s*   e Zd ZdZejZdZdd Zdd Z	dS )ESMTPFactorya  
    An ESMTP server protocol factory.

    @type protocol: no-argument callable which returns a L{Protocol
        <protocol.Protocol>} subclass
    @ivar protocol: A callable which creates a protocol.  The default value is
        L{ESMTP}.

    @type context: L{IOpenSSLContextFactory
        <twisted.internet.interfaces.IOpenSSLContextFactory>} or L{None}
    @ivar context: A factory to generate contexts to be used in negotiating
        encrypted communication.

    @type challengers: L{dict} mapping L{bytes} to no-argument callable which
        returns L{ICredentials <twisted.cred.credentials.ICredentials>}
        subclass provider.
    @ivar challengers: A mapping of acceptable authorization mechanism to
        callable which creates credentials to use for authentication.
    Nc                 G   s    t j| g|R   dti| _dS )zk
        @param args: Arguments for L{SMTPFactory.__init__}

        @see: L{SMTPFactory.__init__}
        s   CRAM-MD5N)rC   r   r   challengers)r   argsr   r   r   r      s   zESMTPFactory.__init__c                 C   s    t | |}| j|_| j|_|S )a  
        Create an instance of an ESMTP server protocol.

        @type addr: L{IAddress <twisted.internet.interfaces.IAddress>} provider
        @param addr: The address of the ESMTP client.

        @rtype: L{ESMTP}
        @return: An ESMTP protocol.
        )rC   rF   rL   contextctxrG   r   r   r   rF      s   
zESMTPFactory.buildProtocol)
r8   r9   r:   r;   r   ESMTPr   rN   r   rF   r   r   r   r   rK      s    	rK   c                   @   s0   e Zd ZdZdZdZdd Zdd Zdd	 ZdS )
VirtualPOP3a[  
    A virtual hosting POP3 server.

    @type service: L{MailService}
    @ivar service: The email service that created this server.  This must be
        set by the service.

    @type domainSpecifier: L{bytes}
    @ivar domainSpecifier: The character to use to split an email address into
        local-part and domain. The default is '@'.
    N   @c                 C   sZ   |  |\}}z| j|}W n ty   tt  Y S w |t	| j
||dtjS )a1  
        Perform APOP authentication.

        Override the default lookup scheme to allow virtual domains.

        @type user: L{bytes}
        @param user: The name of the user attempting to log in.

        @type digest: L{bytes}
        @param digest: The challenge response.

        @rtype: L{Deferred} which successfully results in 3-L{tuple} of
            (L{IMailbox <pop3.IMailbox>}, L{IMailbox <pop3.IMailbox>}
            provider, no-argument callable)
        @return: A deferred which fires when authentication is complete.
            If successful, it returns an L{IMailbox <pop3.IMailbox>} interface,
            a mailbox and a logout function. If authentication fails, the
            deferred fails with an L{UnauthorizedLogin
            <twisted.cred.error.UnauthorizedLogin>} error.
        N)lookupDomainr   lookupPortalKeyErrorr   failr   loginr	   APOPCredentialsmagicIMailbox)r   r   digestr/   rD   r   r   r   authenticateUserAPOP  s   z VirtualPOP3.authenticateUserAPOPc                 C   sT   |  |\}}z| j|}W n ty   tt  Y S w |t||dt	j
S )aY  
        Perform authentication for a username/password login.

        Override the default lookup scheme to allow virtual domains.

        @type user: L{bytes}
        @param user: The name of the user attempting to log in.

        @type password: L{bytes}
        @param password: The password to authenticate with.

        @rtype: L{Deferred} which successfully results in 3-L{tuple} of
            (L{IMailbox <pop3.IMailbox>}, L{IMailbox <pop3.IMailbox>}
            provider, no-argument callable)
        @return: A deferred which fires when authentication is complete.
            If successful, it returns an L{IMailbox <pop3.IMailbox>} interface,
            a mailbox and a logout function. If authentication fails, the
            deferred fails with an L{UnauthorizedLogin
            <twisted.cred.error.UnauthorizedLogin>} error.
        N)rS   r   rT   rU   r   rV   r   rW   r   r	   rZ   )r   r   passwordr/   rD   r   r   r   authenticateUserPASS+  s   z VirtualPOP3.authenticateUserPASSc                 C   sX   z| | jd\}}W n ty   d}Y nw || jjvr(td|d||fS )a  
        Check whether a domain is among the virtual domains supported by the
        mail service.

        @type user: L{bytes}
        @param user: An email address.

        @rtype: 2-L{tuple} of (L{bytes}, L{bytes})
        @return: The local part and the domain part of the email address if the
            domain is supported.

        @raise POP3Error: When the domain is not supported by the mail service.
        r   r   zno such domain {}zutf-8)	splitdomainSpecifier
ValueErrorr   r,   r	   	POP3Errorformatdecode)r   r   r/   r   r   r   rS   H  s   zVirtualPOP3.lookupDomain)	r8   r9   r:   r;   r   r`   r\   r^   rS   r   r   r   r   rQ      s    rQ   c                   @   s(   e Zd ZdZeZdZdd Zdd ZdS )POP3Factorya  
    A POP3 server protocol factory.

    @ivar service: See L{__init__}

    @type protocol: no-argument callable which returns a L{Protocol
        <protocol.Protocol>} subclass
    @ivar protocol: A callable which creates a protocol.  The default value is
        L{VirtualPOP3}.
    Nc                 C   s
   || _ dS )zY
        @type service: L{MailService}
        @param service: An email service.
        N)r   )r   r   r   r   r   r   n  s   
zPOP3Factory.__init__c                 C   s   t j| |}| j|_|S )a   
        Create an instance of a POP3 server protocol.

        @type addr: L{IAddress <twisted.internet.interfaces.IAddress>} provider
        @param addr: The address of the POP3 client.

        @rtype: L{POP3}
        @return: A POP3 protocol.
        )r   ServerFactoryrF   r   rG   r   r   r   rF   u  s   
zPOP3Factory.buildProtocol)	r8   r9   r:   r;   rQ   r   r   r   rF   r   r   r   r   re   _  s    re   N)r;   zope.interfacer   twisted.copyrightr   twisted.cred.credentialsr   r   twisted.cred.errorr   twisted.internetr   r   twisted.mailr	   r
   r   twisted.pythonr   IMessageDeliveryr   r?   rB   rC   rK   POP3rQ   rf   re   r   r   r   r   <module>   s    u.1f