Authentication functions

• mail_auth

  char *mail_auth(char *mechanism, authresponse_t resp, int argc,
        char *argv[]);
  

  
  mechanism

  Authentication mechanism name.

  
  resp

  Callback function for providing responses.

  
  argc

  main() function argc value.

  
  argv

  main() function argv value.

  This server function searches the list of authenticators that was established by auth_link for an authenticator with the given name. If an authenticator is found, authentication is initialized. The function pointed to by resp is called as the authenticator requires responses.

• mail_lookup_auth

  AUTHENTICATOR *mail_lookup_auth(unsigned int i);
  

  
  i

  Position in authenticator list.

  This function returns the ith authenticator in the list, where i is the value of it.

• mail_lookup_auth_name

  unsigned int mail_lookup_auth_name(char *mechanism);
  

  
  mechanism

  Authentication mechanism name.

  This function searches the list of authenticators for an authenticator with the given name, and returns its position in the authenticator list.

  The functions below are provided by C client client drivers or by servers to support the protocol-dependent parts of authentication.

  typedef void *(*authchallenge_t)(void *stream, unsigned long *len);
  

  
  stream

  Stream to read challenge.

  
  len

  Pointer to returned length in octets.

  This driver function is called by an authenticator to read a challenge from the given protocol stream in a protocol-dependent way. It returns that challenge in binary and its length in octets to the authenticator.

• authrespond_t

  typedef long (*authrespond_t)(void *stream, char *s, unsigned long size);
  

  
  stream

  Stream to send response.

  
  s

  Response string.

  
  size

  Length of response string in octets.

  This driver function is called by an authenticator to send a challenge response to the given stream in a protocol-dependent way. It returns T if successful, NIL if failure.

• authresponse_t

  typedef char *(*authresponse_t)(void *challenge, unsigned long clen,
               unsigned long *rlen);
  

  
  challenge

  Challenge string.

  
  clen

  Length of challenge string in octets.

  
  rlen

  Pointer to returned length of response string.

  This server function is called with a challenge string of clen octets. It sends, according to whatever protocol (IMAP, POP, and so on) it uses, and returns the received response and response length in octets.

• authclient_t

  typedef long (*authclient_t)(authchallenge_t challenger,
          authrespond_t responder, NETMBX *mb, void *s, unsigned long trial);
  

  
  challenger

  Pointer to protocol-dependent challenge reader function.

  
  responder

  Pointer to protocol-dependent response sender function.

  
  mb

  NETMBX struct of the mailbox desired to open.

  
  s

  Stream for protocol-dependent routines to use.

  
  trial

  Number of authentication attempts remaining.

  This client authenticator function negotiates reading challenges and sending responses for a particular authenticator over the protocol, and returns T if authenticated or NIL if failed.

• authserver_t

  typedef char *(*authserver_t)(authresponse_t responder, int argc,
          char *argv[]);
  

  
  responder

  Pointer to protocol-dependent responder function.

  
  argc

  main() function argc value.

  
  argv

  main() function argv value.

  This server authenticator function negotiates sending challenges and reading responses for a particular authenticator, and returns either the authenticated user name or NIL if authentication failed.