appl/popper/popper.h

   1 /*
   2  * Copyright (c) 1989 Regents of the University of California.
   3  * All rights reserved.  The Berkeley software License Agreement
   4  * specifies the terms and conditions for redistribution.
   5  *
   6  * static char copyright[] = "Copyright (c) 1990 Regents of the University of California.\nAll rights reserved.\n";
   7  * static char SccsId[] = "@(#)@(#)popper.h     2.2  2.2 4/2/91";
   8  *
   9  */
  10
  11 /* $Id$ */
  12
  13 /*
  14  *  Header file for the POP programs
  15  */
  16
  17 #ifdef HAVE_CONFIG_H
  18 #include <config.h>
  19 #define UIDL
  20 #define XOVER
  21 #define XDELE
  22 #define DEBUG
  23 #define RETURN_PATH_HANDLING
  24 #endif
  25
  26 /* Common include files */
  27
  28 #include <stdio.h>
  29 #include <stdarg.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <errno.h>
  33 #include <signal.h>
  34 #include <setjmp.h>
  35 #include <ctype.h>
  36 #ifdef HAVE_FCNTL_H
  37 #include <fcntl.h>
  38 #endif
  39 #ifdef HAVE_PWD_H
  40 #include <pwd.h>
  41 #endif
  42 #ifdef HAVE_SYS_TYPES_H
  43 #include <sys/types.h>
  44 #endif
  45 #ifdef HAVE_IO_H
  46 #include <io.h>
  47 #endif
  48 #ifdef HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51 #ifdef HAVE_SYS_STAT_H
  52 #include <sys/stat.h>
  53 #endif
  54 #ifdef HAVE_SYS_FILE_H
  55 #include <sys/file.h>
  56 #endif
  57 #ifdef TIME_WITH_SYS_TIME
  58 #include <sys/time.h>
  59 #include <time.h>
  60 #elif defined(HAVE_SYS_TIME_H)
  61 #include <sys/time.h>
  62 #else
  63 #include <time.h>
  64 #endif
  65 #ifdef HAVE_SYS_RESOURCE_H
  66 #include <sys/resource.h>
  67 #endif
  68 #ifdef HAVE_SYS_WAIT_H
  69 #include <sys/wait.h>
  70 #endif
  71 #ifdef HAVE_SYS_SOCKET_H
  72 #include <sys/socket.h>
  73 #endif
  74 #ifdef HAVE_NETINET_IN_H
  75 #include <netinet/in.h>
  76 #endif
  77 #ifdef HAVE_NETINET_IN6_H
  78 #include <netinet/in6.h>
  79 #endif
  80 #ifdef HAVE_NETINET6_IN6_H
  81 #include <netinet6/in6.h>
  82 #endif
  83
  84 #ifdef HAVE_NETDB_H
  85 #include <netdb.h>
  86 #endif
  87 #ifdef HAVE_ARPA_INET_H
  88 #ifdef _AIX
  89 struct sockaddr_dl; /* AIX fun */
  90 struct ether_addr;
  91 #endif
  92 #include <arpa/inet.h>
  93 #endif
  94 #ifdef HAVE_SYSLOG_H
  95 #include <syslog.h>
  96 #endif
  97 #ifdef HAVE_SYS_SELECT_H
  98 #include <sys/select.h>
  99 #endif
 100 #ifdef HAVE_SYS_PARAM_H
 101 #include <sys/param.h>
 102 #endif
 103 #include "version.h"
 104
 105 #ifdef SOCKS
 106 #include <socks.h>
 107 #endif
 108
 109 #include <err.h>
 110 #include <roken.h>
 111 #include <getarg.h>
 112
 113 #ifdef KRB4
 114 #include <krb.h>
 115 #include <prot.h>
 116 #endif
 117 #ifdef KRB5
 118 #include <krb5.h>
 119 #endif
 120
 121 #define MAXUSERNAMELEN  65
 122 #define MAXLINELEN      1024
 123 #define MAXMSGLINELEN   1024
 124 #define MAXCMDLEN       4
 125 #define MAXPARMCOUNT    10
 126 #define MAXPARMLEN      10
 127 #define ALLOC_MSGS  20
 128 #define MAIL_COMMAND    "/usr/lib/sendmail"
 129
 130 #define POP_FACILITY    LOG_LOCAL0
 131 #define POP_PRIORITY    LOG_NOTICE
 132 #define POP_DEBUG       LOG_DEBUG
 133 #define POP_INFO        LOG_INFO
 134 #define POP_LOGOPTS     0
 135
 136 #ifdef HAVE_PATHS_H
 137 #include <paths.h>
 138 #endif
 139 #ifdef HAVE_MAILLOCK_H
 140 #include <maillock.h>
 141 #endif
 142
 143 #ifdef OTP
 144 #include <otp.h>
 145 #endif
 146
 147 #if defined(KRB4_MAILDIR)
 148 #define POP_MAILDIR     KRB4_MAILDIR
 149 #elif defined(_PATH_MAILDIR)
 150 #define POP_MAILDIR     _PATH_MAILDIR
 151 #elif defined(MAILDIR)
 152 #define POP_MAILDIR     MAILDIR
 153 #else
 154 #define POP_MAILDIR     "/usr/spool/mail"
 155 #endif
 156
 157 #define POP_DROP        POP_MAILDIR "/.%s.pop"
 158         /* POP_TMPSIZE needs to be big enough to hold the string
 159          * defined by POP_TMPDROP.  POP_DROP and POP_TMPDROP
 160          * must be in the same filesystem.
 161          */
 162 #define POP_TMPDROP     POP_MAILDIR "/tmpXXXXXX"
 163 #define POP_TMPSIZE     256
 164 #define POP_TMPXMIT     "/tmp/xmitXXXXXX"
 165 #define POP_OK          "+OK"
 166 #define POP_ERR         "-ERR"
 167 #define POP_SUCCESS     1
 168 #define POP_FAILURE     0
 169 #define POP_TERMINATE   '.'
 170 #define POP_TIMEOUT     120     /* timeout connection after this many secs */
 171
 172 extern int              pop_timeout;
 173
 174 extern int              hangup;
 175
 176 #define AUTH_NONE 0
 177 #define AUTH_OTP  1
 178 #define AUTH_SASL 2
 179
 180 #define pop_command         pop_parm[0]     /*  POP command is first token */
 181 #define pop_subcommand      pop_parm[1]     /*  POP XTND subcommand is the
 182                                                 second token */
 183
 184 typedef enum {                              /*  POP processing states */
 185     auth1,                                  /*  Authorization: waiting for
 186                                                 USER command */
 187     auth2,                                  /*  Authorization: waiting for
 188                                                 PASS command */
 189     trans,                                  /*  Transaction */
 190     update,                                 /*  Update:  session ended,
 191                                                 process maildrop changes */
 192     halt,                                   /*  (Halt):  stop processing
 193                                                 and exit */
 194     error                                   /*  (Error): something really
 195                                                 bad happened */
 196 } state;
 197
 198
 199 #define DEL_FLAG        1
 200 #define RETR_FLAG       2
 201 #define NEW_FLAG        4
 202
 203 typedef struct {                                /*  Message information */
 204     int         number;                         /*  Message number relative to
 205                                                     the beginning of list */
 206     long        length;                         /*  Length of message in
 207                                                     bytes */
 208     int         lines;                          /*  Number of (null-terminated)                                                     lines in the message */
 209     long        offset;                         /*  Offset from beginning of
 210                                                     file */
 211     unsigned    flags;
 212
 213 #if defined(UIDL) || defined(XOVER)
 214     char        *msg_id;                        /*  The POP UIDL uniqueifier */
 215 #endif
 216 #ifdef XOVER
 217     char        *subject;
 218     char        *from;
 219     char        *date;
 220 #endif
 221     char        *name;
 222 } MsgInfoList;
 223
 224 #define IS_MAILDIR(P) ((P)->temp_drop[0] == '\0')
 225
 226 typedef struct  {                               /*  POP parameter block */
 227     int                 debug;                  /*  Debugging requested */
 228     char            *   myname;                 /*  The name of this POP
 229                                                     daemon program */
 230     char                myhost[MaxHostNameLen]; /*  The name of our host
 231                                                     computer */
 232     char                client[MaxHostNameLen]; /*  Canonical name of client
 233                                                     computer */
 234     char                ipaddr[MaxHostNameLen]; /*  Dotted-notation format of
 235                                                     client IP address */
 236     unsigned short      ipport;                 /*  Client port for privileged
 237                                                     operations */
 238     char                user[MAXUSERNAMELEN];   /*  Name of the POP user */
 239     state               CurrentState;           /*  The current POP operational                                                     state */
 240     MsgInfoList     *   mlp;                    /*  Message information list */
 241     int                 msg_count;              /*  Number of messages in
 242                                                     the maildrop */
 243     int                 msgs_deleted;           /*  Number of messages flagged
 244                                                     for deletion */
 245     int                 last_msg;               /*  Last message touched by
 246                                                     the user */
 247     long                bytes_deleted;          /*  Number of maildrop bytes
 248                                                     flagged for deletion */
 249     char                drop_name[MAXPATHLEN];  /*  The name of the user's
 250                                                     maildrop */
 251     char                temp_drop[MAXPATHLEN];  /*  The name of the user's
 252                                                     temporary maildrop */
 253     long                drop_size;              /*  Size of the maildrop in
 254                                                     bytes */
 255     FILE            *   drop;                   /*  (Temporary) mail drop */
 256     FILE            *   input;                  /*  Input TCP/IP communication
 257                                                     stream */
 258     FILE            *   output;                 /*  Output TCP/IP communication                                                     stream */
 259     FILE            *   trace;                  /*  Debugging trace file */
 260     char            *   pop_parm[MAXPARMCOUNT]; /*  Parse POP parameter list */
 261     int                 parm_count;             /*  Number of parameters in
 262                                                     parsed list */
 263     int                 kerberosp;              /*  Using KPOP? */
 264 #ifdef KRB4
 265     AUTH_DAT            kdata;
 266 #endif
 267 #ifdef KRB5
 268     krb5_context        context;
 269     krb5_principal      principal;              /*  principal auth as */
 270     krb5_log_facility*  logf;
 271 #endif
 272     int                 version;                /*  4 or 5? */
 273     int                 auth_level;             /*  Dont allow cleartext */
 274 #ifdef OTP
 275     OtpContext          otp_ctx;                /*  OTP context */
 276 #endif
 277     unsigned int        flags;
 278 #define POP_FLAG_CAPA   1
 279 } POP;
 280
 281 typedef struct {                                /*  State information for
 282                                                     each POP command */
 283     state       ValidCurrentState;              /*  The operating state of
 284                                                     the command */
 285     char   *    command;                        /*  The POP command */
 286     int         min_parms;                      /*  Minimum number of parms
 287                                                     for the command */
 288     int         max_parms;                      /*  Maximum number of parms
 289                                                     for the command */
 290     int         (*function) ();                 /*  The function that process
 291                                                     the command */
 292     state       result[2];                      /*  The resulting state after
 293                                                     command processing */
 294 #define success_state   result[0]               /*  State when a command
 295                                                     succeeds */
 296 } state_table;
 297
 298 typedef struct {                                /*  Table of extensions */
 299     char   *    subcommand;                     /*  The POP XTND subcommand */
 300     int         min_parms;                      /*  Minimum number of parms for
 301                                                     the subcommand */
 302     int         max_parms;                      /*  Maximum number of parms for
 303                                                     the subcommand */
 304     int         (*function) ();                 /*  The function that processes
 305                                                     the subcommand */
 306 } xtnd_table;
 307
 308 int pop_dele(POP *p);
 309 int pop_dropcopy(POP *p, struct passwd *pwp);
 310 int pop_dropinfo(POP *p);
 311 int pop_init(POP *p,int argcount,char **argmessage);
 312 int pop_last(POP *p);
 313 int pop_list(POP *p);
 314 int pop_parse(POP *p, char *buf);
 315 int pop_pass(POP *p);
 316 int pop_quit(POP *p);
 317 int pop_rset(POP *p);
 318 int pop_send(POP *p);
 319 int pop_stat(POP *p);
 320 int pop_updt(POP *p);
 321 int pop_user(POP *p);
 322 #ifdef UIDL
 323 int pop_uidl(POP *p);
 324 #endif
 325 #ifdef XOVER
 326 int pop_xover(POP *p);
 327 #endif
 328 #ifdef XDELE
 329 int pop_xdele(POP *p);
 330 #endif
 331 int pop_help(POP *p);
 332 state_table *pop_get_command(POP *p, char *mp);
 333 void pop_lower(char *buf);
 334 #ifdef SASL
 335 int pop_auth (POP *p);
 336 void pop_capa_sasl(POP *p);
 337 #endif
 338
 339 int pop_log(POP *p, int stat, char *format, ...)
 340 #ifdef __GNUC__
 341 __attribute__ ((format (printf, 3, 4)))
 342 #endif
 343 ;
 344
 345 int pop_msg(POP *p, int stat, char *format, ...)
 346 #ifdef __GNUC__
 347 __attribute__ ((format (printf, 3, 4)))
 348 #endif
 349 ;
 350
 351 int pop_maildir_info (POP*);
 352 int pop_maildir_open (POP*, MsgInfoList*);
 353 int pop_maildir_update (POP*);
 354
 355 int changeuser(POP*, struct passwd*);
 356 void parse_header(MsgInfoList*, char*);
 357 int add_missing_headers(POP*, MsgInfoList*);
 358 int login_user(POP *p);