(socket_connection): Add conditionals for HAVE_KRB5_ERROR_TEXT and
[emacs.git] / lib-src / pop.c
blob29c9712d3ec51e22f4cc3a568687f5b9d7a96557
1 /* pop.c: client routines for talking to a POP3-protocol post-office server
2 Copyright (C) 1991, 1993, 1996, 1997, 1999, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4 Written by Jonathan Kamens, jik@security.ov.com.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #ifdef HAVE_CONFIG_H
24 #define NO_SHORTNAMES /* Tell config not to load remap.h */
25 #include <config.h>
26 #else
27 #define MAIL_USE_POP
28 #endif
30 #ifdef MAIL_USE_POP
32 #include <sys/types.h>
33 #ifdef WINDOWSNT
34 #include "ntlib.h"
35 #include <winsock.h>
36 #undef SOCKET_ERROR
37 #define RECV(s,buf,len,flags) recv(s,buf,len,flags)
38 #define SEND(s,buf,len,flags) send(s,buf,len,flags)
39 #define CLOSESOCKET(s) closesocket(s)
40 #else
41 #include <netinet/in.h>
42 #include <sys/socket.h>
43 #define RECV(s,buf,len,flags) read(s,buf,len)
44 #define SEND(s,buf,len,flags) write(s,buf,len)
45 #define CLOSESOCKET(s) close(s)
46 #endif
47 #include <pop.h>
49 #ifdef sun
50 #include <malloc.h>
51 #endif /* sun */
53 #ifdef HESIOD
54 #include <hesiod.h>
56 * It really shouldn't be necessary to put this declaration here, but
57 * the version of hesiod.h that Athena has installed in release 7.2
58 * doesn't declare this function; I don't know if the 7.3 version of
59 * hesiod.h does.
61 extern struct servent *hes_getservbyname (/* char *, char * */);
62 #endif
64 #include <pwd.h>
65 #include <netdb.h>
66 #include <errno.h>
67 #include <stdio.h>
68 #ifdef STDC_HEADERS
69 #include <string.h>
70 #define index strchr
71 #endif
72 #ifdef HAVE_UNISTD_H
73 #include <unistd.h>
74 #endif
76 #ifdef KERBEROS
77 # ifdef HAVE_KRB5_H
78 # include <krb5.h>
79 # endif
80 # ifdef HAVE_KRB_H
81 # include <krb.h>
82 # else
83 # ifdef HAVE_KERBEROSIV_KRB_H
84 # include <kerberosIV/krb.h>
85 # else
86 # ifdef HAVE_KERBEROS_KRB_H
87 # include <kerberos/krb.h>
88 # endif
89 # endif
90 # endif
91 # ifdef HAVE_COM_ERR_H
92 # include <com_err.h>
93 # endif
94 #endif /* KERBEROS */
96 #ifdef KERBEROS
97 #ifndef KERBEROS5
98 extern int krb_sendauth (/* long, int, KTEXT, char *, char *, char *,
99 u_long, MSG_DAT *, CREDENTIALS *, Key_schedule,
100 struct sockaddr_in *, struct sockaddr_in *,
101 char * */);
102 extern char *krb_realmofhost (/* char * */);
103 #endif /* ! KERBEROS5 */
104 #endif /* KERBEROS */
106 #ifndef WINDOWSNT
107 #if !defined(HAVE_H_ERRNO) || !defined(HAVE_CONFIG_H)
108 extern int h_errno;
109 #endif
110 #endif
112 #ifndef __P
113 # ifdef __STDC__
114 # define __P(a) a
115 # else
116 # define __P(a) ()
117 # endif /* __STDC__ */
118 #endif /* ! __P */
120 static int socket_connection __P((char *, int));
121 static int pop_getline __P((popserver, char **));
122 static int sendline __P((popserver, char *));
123 static int fullwrite __P((int, char *, int));
124 static int getok __P((popserver));
125 #if 0
126 static int gettermination __P((popserver));
127 #endif
128 static void pop_trash __P((popserver));
129 static char *find_crlf __P((char *, int));
131 #define ERROR_MAX 160 /* a pretty arbitrary size, but needs
132 to be bigger than the original
133 value of 80 */
134 #define POP_PORT 110
135 #define KPOP_PORT 1109
136 #define POP_SERVICE "pop3" /* we don't want the POP2 port! */
137 #ifdef KERBEROS
138 #define KPOP_SERVICE "kpop" /* never used: look for 20060515 to see why */
139 #endif
141 char pop_error[ERROR_MAX];
142 int pop_debug = 0;
144 #ifndef min
145 #define min(a,b) (((a) < (b)) ? (a) : (b))
146 #endif
149 * Function: pop_open (char *host, char *username, char *password,
150 * int flags)
152 * Purpose: Establishes a connection with a post-office server, and
153 * completes the authorization portion of the session.
155 * Arguments:
156 * host The server host with which the connection should be
157 * established. Optional. If omitted, internal
158 * heuristics will be used to determine the server host,
159 * if possible.
160 * username
161 * The username of the mail-drop to access. Optional.
162 * If omitted, internal heuristics will be used to
163 * determine the username, if possible.
164 * password
165 * The password to use for authorization. If omitted,
166 * internal heuristics will be used to determine the
167 * password, if possible.
168 * flags A bit mask containing flags controlling certain
169 * functions of the routine. Valid flags are defined in
170 * the file pop.h
172 * Return value: Upon successful establishment of a connection, a
173 * non-null popserver will be returned. Otherwise, null will be
174 * returned, and the string variable pop_error will contain an
175 * explanation of the error.
177 popserver
178 pop_open (host, username, password, flags)
179 char *host;
180 char *username;
181 char *password;
182 int flags;
184 int sock;
185 popserver server;
187 /* Determine the user name */
188 if (! username)
190 username = getenv ("USER");
191 if (! (username && *username))
193 username = getlogin ();
194 if (! (username && *username))
196 struct passwd *passwd;
197 passwd = getpwuid (getuid ());
198 if (passwd && passwd->pw_name && *passwd->pw_name)
200 username = passwd->pw_name;
202 else
204 strcpy (pop_error, "Could not determine username");
205 return (0);
212 * Determine the mail host.
215 if (! host)
217 host = getenv ("MAILHOST");
220 #ifdef HESIOD
221 if ((! host) && (! (flags & POP_NO_HESIOD)))
223 struct hes_postoffice *office;
224 office = hes_getmailhost (username);
225 if (office && office->po_type && (! strcmp (office->po_type, "POP"))
226 && office->po_name && *office->po_name && office->po_host
227 && *office->po_host)
229 host = office->po_host;
230 username = office->po_name;
233 #endif
235 #ifdef MAILHOST
236 if (! host)
238 host = MAILHOST;
240 #endif
242 if (! host)
244 strcpy (pop_error, "Could not determine POP server");
245 return (0);
248 /* Determine the password */
249 #ifdef KERBEROS
250 #define DONT_NEED_PASSWORD (! (flags & POP_NO_KERBEROS))
251 #else
252 #define DONT_NEED_PASSWORD 0
253 #endif
255 if ((! password) && (! DONT_NEED_PASSWORD))
257 if (! (flags & POP_NO_GETPASS))
259 password = getpass ("Enter POP password:");
261 if (! password)
263 strcpy (pop_error, "Could not determine POP password");
264 return (0);
267 if (password) /* always true, detected 20060515 */
268 flags |= POP_NO_KERBEROS;
269 else
270 password = username; /* dead code, detected 20060515 */
271 /** "kpop" service is never used: look for 20060515 to see why **/
273 sock = socket_connection (host, flags);
274 if (sock == -1)
275 return (0);
277 server = (popserver) malloc (sizeof (struct _popserver));
278 if (! server)
280 strcpy (pop_error, "Out of memory in pop_open");
281 return (0);
283 server->buffer = (char *) malloc (GETLINE_MIN);
284 if (! server->buffer)
286 strcpy (pop_error, "Out of memory in pop_open");
287 free ((char *) server);
288 return (0);
291 server->file = sock;
292 server->data = 0;
293 server->buffer_index = 0;
294 server->buffer_size = GETLINE_MIN;
295 server->in_multi = 0;
296 server->trash_started = 0;
298 if (getok (server))
299 return (0);
302 * I really shouldn't use the pop_error variable like this, but....
304 if (strlen (username) > ERROR_MAX - 6)
306 pop_close (server);
307 strcpy (pop_error,
308 "Username too long; recompile pop.c with larger ERROR_MAX");
309 return (0);
311 sprintf (pop_error, "USER %s", username);
313 if (sendline (server, pop_error) || getok (server))
315 return (0);
318 if (strlen (password) > ERROR_MAX - 6)
320 pop_close (server);
321 strcpy (pop_error,
322 "Password too long; recompile pop.c with larger ERROR_MAX");
323 return (0);
325 sprintf (pop_error, "PASS %s", password);
327 if (sendline (server, pop_error) || getok (server))
329 return (0);
332 return (server);
336 * Function: pop_stat
338 * Purpose: Issue the STAT command to the server and return (in the
339 * value parameters) the number of messages in the maildrop and
340 * the total size of the maildrop.
342 * Return value: 0 on success, or non-zero with an error in pop_error
343 * in failure.
345 * Side effects: On failure, may make further operations on the
346 * connection impossible.
349 pop_stat (server, count, size)
350 popserver server;
351 int *count;
352 int *size;
354 char *fromserver;
355 char *end_ptr;
357 if (server->in_multi)
359 strcpy (pop_error, "In multi-line query in pop_stat");
360 return (-1);
363 if (sendline (server, "STAT") || (pop_getline (server, &fromserver) < 0))
364 return (-1);
366 if (strncmp (fromserver, "+OK ", 4))
368 if (0 == strncmp (fromserver, "-ERR", 4))
370 strncpy (pop_error, fromserver, ERROR_MAX);
372 else
374 strcpy (pop_error,
375 "Unexpected response from POP server in pop_stat");
376 pop_trash (server);
378 return (-1);
381 errno = 0;
382 *count = strtol (&fromserver[4], &end_ptr, 10);
383 /* Check validity of string-to-integer conversion. */
384 if (fromserver + 4 == end_ptr || *end_ptr != ' ' || errno)
386 strcpy (pop_error, "Unexpected response from POP server in pop_stat");
387 pop_trash (server);
388 return (-1);
391 fromserver = end_ptr;
393 errno = 0;
394 *size = strtol (fromserver + 1, &end_ptr, 10);
395 if (fromserver + 1 == end_ptr || errno)
397 strcpy (pop_error, "Unexpected response from POP server in pop_stat");
398 pop_trash (server);
399 return (-1);
402 return (0);
406 * Function: pop_list
408 * Purpose: Performs the POP "list" command and returns (in value
409 * parameters) two malloc'd zero-terminated arrays -- one of
410 * message IDs, and a parallel one of sizes.
412 * Arguments:
413 * server The pop connection to talk to.
414 * message The number of the one message about which to get
415 * information, or 0 to get information about all
416 * messages.
418 * Return value: 0 on success, non-zero with error in pop_error on
419 * failure.
421 * Side effects: On failure, may make further operations on the
422 * connection impossible.
425 pop_list (server, message, IDs, sizes)
426 popserver server;
427 int message;
428 int **IDs;
429 int **sizes;
431 int how_many, i;
432 char *fromserver;
434 if (server->in_multi)
436 strcpy (pop_error, "In multi-line query in pop_list");
437 return (-1);
440 if (message)
441 how_many = 1;
442 else
444 int count, size;
445 if (pop_stat (server, &count, &size))
446 return (-1);
447 how_many = count;
450 *IDs = (int *) malloc ((how_many + 1) * sizeof (int));
451 *sizes = (int *) malloc ((how_many + 1) * sizeof (int));
452 if (! (*IDs && *sizes))
454 strcpy (pop_error, "Out of memory in pop_list");
455 return (-1);
458 if (message)
460 sprintf (pop_error, "LIST %d", message);
461 if (sendline (server, pop_error))
463 free ((char *) *IDs);
464 free ((char *) *sizes);
465 return (-1);
467 if (pop_getline (server, &fromserver) < 0)
469 free ((char *) *IDs);
470 free ((char *) *sizes);
471 return (-1);
473 if (strncmp (fromserver, "+OK ", 4))
475 if (! strncmp (fromserver, "-ERR", 4))
476 strncpy (pop_error, fromserver, ERROR_MAX);
477 else
479 strcpy (pop_error,
480 "Unexpected response from server in pop_list");
481 pop_trash (server);
483 free ((char *) *IDs);
484 free ((char *) *sizes);
485 return (-1);
487 (*IDs)[0] = atoi (&fromserver[4]);
488 fromserver = index (&fromserver[4], ' ');
489 if (! fromserver)
491 strcpy (pop_error,
492 "Badly formatted response from server in pop_list");
493 pop_trash (server);
494 free ((char *) *IDs);
495 free ((char *) *sizes);
496 return (-1);
498 (*sizes)[0] = atoi (fromserver);
499 (*IDs)[1] = (*sizes)[1] = 0;
500 return (0);
502 else
504 if (pop_multi_first (server, "LIST", &fromserver))
506 free ((char *) *IDs);
507 free ((char *) *sizes);
508 return (-1);
510 for (i = 0; i < how_many; i++)
512 if (pop_multi_next (server, &fromserver) <= 0)
514 free ((char *) *IDs);
515 free ((char *) *sizes);
516 return (-1);
518 (*IDs)[i] = atoi (fromserver);
519 fromserver = index (fromserver, ' ');
520 if (! fromserver)
522 strcpy (pop_error,
523 "Badly formatted response from server in pop_list");
524 free ((char *) *IDs);
525 free ((char *) *sizes);
526 pop_trash (server);
527 return (-1);
529 (*sizes)[i] = atoi (fromserver);
531 if (pop_multi_next (server, &fromserver) < 0)
533 free ((char *) *IDs);
534 free ((char *) *sizes);
535 return (-1);
537 else if (fromserver)
539 strcpy (pop_error,
540 "Too many response lines from server in pop_list");
541 free ((char *) *IDs);
542 free ((char *) *sizes);
543 return (-1);
545 (*IDs)[i] = (*sizes)[i] = 0;
546 return (0);
551 * Function: pop_retrieve
553 * Purpose: Retrieve a specified message from the maildrop.
555 * Arguments:
556 * server The server to retrieve from.
557 * message The message number to retrieve.
558 * markfrom
559 * If true, then mark the string "From " at the beginning
560 * of lines with '>'.
561 * msg_buf Output parameter to which a buffer containing the
562 * message is assigned.
564 * Return value: The number of bytes in msg_buf, which may contain
565 * embedded nulls, not including its final null, or -1 on error
566 * with pop_error set.
568 * Side effects: May kill connection on error.
571 pop_retrieve (server, message, markfrom, msg_buf)
572 popserver server;
573 int message;
574 int markfrom;
575 char **msg_buf;
577 int *IDs, *sizes, bufsize, fromcount = 0, cp = 0;
578 char *ptr, *fromserver;
579 int ret;
581 if (server->in_multi)
583 strcpy (pop_error, "In multi-line query in pop_retrieve");
584 return (-1);
587 if (pop_list (server, message, &IDs, &sizes))
588 return (-1);
590 if (pop_retrieve_first (server, message, &fromserver))
592 return (-1);
596 * The "5" below is an arbitrary constant -- I assume that if
597 * there are "From" lines in the text to be marked, there
598 * probably won't be more than 5 of them. If there are, I
599 * allocate more space for them below.
601 bufsize = sizes[0] + (markfrom ? 5 : 0);
602 ptr = (char *)malloc (bufsize);
603 free ((char *) IDs);
604 free ((char *) sizes);
606 if (! ptr)
608 strcpy (pop_error, "Out of memory in pop_retrieve");
609 pop_retrieve_flush (server);
610 return (-1);
613 while ((ret = pop_retrieve_next (server, &fromserver)) >= 0)
615 if (! fromserver)
617 ptr[cp] = '\0';
618 *msg_buf = ptr;
619 return (cp);
621 if (markfrom && fromserver[0] == 'F' && fromserver[1] == 'r' &&
622 fromserver[2] == 'o' && fromserver[3] == 'm' &&
623 fromserver[4] == ' ')
625 if (++fromcount == 5)
627 bufsize += 5;
628 ptr = (char *)realloc (ptr, bufsize);
629 if (! ptr)
631 strcpy (pop_error, "Out of memory in pop_retrieve");
632 pop_retrieve_flush (server);
633 return (-1);
635 fromcount = 0;
637 ptr[cp++] = '>';
639 bcopy (fromserver, &ptr[cp], ret);
640 cp += ret;
641 ptr[cp++] = '\n';
644 free (ptr);
645 return (-1);
649 pop_retrieve_first (server, message, response)
650 popserver server;
651 int message;
652 char **response;
654 sprintf (pop_error, "RETR %d", message);
655 return (pop_multi_first (server, pop_error, response));
659 Returns a negative number on error, 0 to indicate that the data has
660 all been read (i.e., the server has returned a "." termination
661 line), or a positive number indicating the number of bytes in the
662 returned buffer (which is null-terminated and may contain embedded
663 nulls, but the returned bytecount doesn't include the final null).
667 pop_retrieve_next (server, line)
668 popserver server;
669 char **line;
671 return (pop_multi_next (server, line));
675 pop_retrieve_flush (server)
676 popserver server;
678 return (pop_multi_flush (server));
682 pop_top_first (server, message, lines, response)
683 popserver server;
684 int message, lines;
685 char **response;
687 sprintf (pop_error, "TOP %d %d", message, lines);
688 return (pop_multi_first (server, pop_error, response));
692 Returns a negative number on error, 0 to indicate that the data has
693 all been read (i.e., the server has returned a "." termination
694 line), or a positive number indicating the number of bytes in the
695 returned buffer (which is null-terminated and may contain embedded
696 nulls, but the returned bytecount doesn't include the final null).
700 pop_top_next (server, line)
701 popserver server;
702 char **line;
704 return (pop_multi_next (server, line));
708 pop_top_flush (server)
709 popserver server;
711 return (pop_multi_flush (server));
715 pop_multi_first (server, command, response)
716 popserver server;
717 char *command;
718 char **response;
720 if (server->in_multi)
722 strcpy (pop_error,
723 "Already in multi-line query in pop_multi_first");
724 return (-1);
727 if (sendline (server, command) || (pop_getline (server, response) < 0))
729 return (-1);
732 if (0 == strncmp (*response, "-ERR", 4))
734 strncpy (pop_error, *response, ERROR_MAX);
735 return (-1);
737 else if (0 == strncmp (*response, "+OK", 3))
739 for (*response += 3; **response == ' '; (*response)++) /* empty */;
740 server->in_multi = 1;
741 return (0);
743 else
745 strcpy (pop_error,
746 "Unexpected response from server in pop_multi_first");
747 return (-1);
752 Read the next line of data from SERVER and place a pointer to it
753 into LINE. Return -1 on error, 0 if there are no more lines to read
754 (i.e., the server has returned a line containing only "."), or a
755 positive number indicating the number of bytes in the LINE buffer
756 (not including the final null). The data in that buffer may contain
757 embedded nulls, but does not contain the final CRLF. When returning
758 0, LINE is set to null. */
761 pop_multi_next (server, line)
762 popserver server;
763 char **line;
765 char *fromserver;
766 int ret;
768 if (! server->in_multi)
770 strcpy (pop_error, "Not in multi-line query in pop_multi_next");
771 return (-1);
774 if ((ret = pop_getline (server, &fromserver)) < 0)
776 return (-1);
779 if (fromserver[0] == '.')
781 if (! fromserver[1])
783 *line = 0;
784 server->in_multi = 0;
785 return (0);
787 else
789 *line = fromserver + 1;
790 return (ret - 1);
793 else
795 *line = fromserver;
796 return (ret);
801 pop_multi_flush (server)
802 popserver server;
804 char *line;
805 int ret;
807 if (! server->in_multi)
809 return (0);
812 while ((ret = pop_multi_next (server, &line)))
814 if (ret < 0)
815 return (-1);
818 return (0);
821 /* Function: pop_delete
823 * Purpose: Delete a specified message.
825 * Arguments:
826 * server Server from which to delete the message.
827 * message Message to delete.
829 * Return value: 0 on success, non-zero with error in pop_error
830 * otherwise.
833 pop_delete (server, message)
834 popserver server;
835 int message;
837 if (server->in_multi)
839 strcpy (pop_error, "In multi-line query in pop_delete");
840 return (-1);
843 sprintf (pop_error, "DELE %d", message);
845 if (sendline (server, pop_error) || getok (server))
846 return (-1);
848 return (0);
852 * Function: pop_noop
854 * Purpose: Send a noop command to the server.
856 * Argument:
857 * server The server to send to.
859 * Return value: 0 on success, non-zero with error in pop_error
860 * otherwise.
862 * Side effects: Closes connection on error.
865 pop_noop (server)
866 popserver server;
868 if (server->in_multi)
870 strcpy (pop_error, "In multi-line query in pop_noop");
871 return (-1);
874 if (sendline (server, "NOOP") || getok (server))
875 return (-1);
877 return (0);
881 * Function: pop_last
883 * Purpose: Find out the highest seen message from the server.
885 * Arguments:
886 * server The server.
888 * Return value: If successful, the highest seen message, which is
889 * greater than or equal to 0. Otherwise, a negative number with
890 * the error explained in pop_error.
892 * Side effects: Closes the connection on error.
895 pop_last (server)
896 popserver server;
898 char *fromserver;
900 if (server->in_multi)
902 strcpy (pop_error, "In multi-line query in pop_last");
903 return (-1);
906 if (sendline (server, "LAST"))
907 return (-1);
909 if (pop_getline (server, &fromserver) < 0)
910 return (-1);
912 if (! strncmp (fromserver, "-ERR", 4))
914 strncpy (pop_error, fromserver, ERROR_MAX);
915 return (-1);
917 else if (strncmp (fromserver, "+OK ", 4))
919 strcpy (pop_error, "Unexpected response from server in pop_last");
920 pop_trash (server);
921 return (-1);
923 else
925 char *end_ptr;
926 int count;
927 errno = 0;
928 count = strtol (&fromserver[4], &end_ptr, 10);
929 if (fromserver + 4 == end_ptr || errno)
931 strcpy (pop_error, "Unexpected response from server in pop_last");
932 pop_trash (server);
933 return (-1);
935 return count;
940 * Function: pop_reset
942 * Purpose: Reset the server to its initial connect state
944 * Arguments:
945 * server The server.
947 * Return value: 0 for success, non-0 with error in pop_error
948 * otherwise.
950 * Side effects: Closes the connection on error.
953 pop_reset (server)
954 popserver server;
956 if (pop_retrieve_flush (server))
958 return (-1);
961 if (sendline (server, "RSET") || getok (server))
962 return (-1);
964 return (0);
968 * Function: pop_quit
970 * Purpose: Quit the connection to the server,
972 * Arguments:
973 * server The server to quit.
975 * Return value: 0 for success, non-zero otherwise with error in
976 * pop_error.
978 * Side Effects: The popserver passed in is unusable after this
979 * function is called, even if an error occurs.
982 pop_quit (server)
983 popserver server;
985 int ret = 0;
987 if (server->file >= 0)
989 if (pop_retrieve_flush (server))
991 ret = -1;
994 if (sendline (server, "QUIT") || getok (server))
996 ret = -1;
999 close (server->file);
1002 if (server->buffer)
1003 free (server->buffer);
1004 free ((char *) server);
1006 return (ret);
1009 #ifdef WINDOWSNT
1010 static int have_winsock = 0;
1011 #endif
1014 * Function: socket_connection
1016 * Purpose: Opens the network connection with the mail host, without
1017 * doing any sort of I/O with it or anything.
1019 * Arguments:
1020 * host The host to which to connect.
1021 * flags Option flags.
1023 * Return value: A file descriptor indicating the connection, or -1
1024 * indicating failure, in which case an error has been copied
1025 * into pop_error.
1027 static int
1028 socket_connection (host, flags)
1029 char *host;
1030 int flags;
1032 struct hostent *hostent;
1033 struct servent *servent;
1034 struct sockaddr_in addr;
1035 char found_port = 0;
1036 char *service;
1037 int sock;
1038 #ifdef KERBEROS
1039 #ifdef KERBEROS5
1040 krb5_error_code rem;
1041 krb5_context kcontext = 0;
1042 krb5_auth_context auth_context = 0;
1043 krb5_ccache ccdef;
1044 krb5_principal client, server;
1045 krb5_error *err_ret;
1046 register char *cp;
1047 #else
1048 KTEXT ticket;
1049 MSG_DAT msg_data;
1050 CREDENTIALS cred;
1051 Key_schedule schedule;
1052 int rem;
1053 char *realhost;
1054 #endif /* KERBEROS5 */
1055 #endif /* KERBEROS */
1057 int try_count = 0;
1059 #ifdef WINDOWSNT
1061 WSADATA winsockData;
1062 if (WSAStartup (0x101, &winsockData) == 0)
1063 have_winsock = 1;
1065 #endif
1067 bzero ((char *) &addr, sizeof (addr));
1068 addr.sin_family = AF_INET;
1070 /** "kpop" service is never used: look for 20060515 to see why **/
1071 #ifdef KERBEROS
1072 service = (flags & POP_NO_KERBEROS) ? POP_SERVICE : KPOP_SERVICE;
1073 #else
1074 service = POP_SERVICE;
1075 #endif
1077 #ifdef HESIOD
1078 if (! (flags & POP_NO_HESIOD))
1080 servent = hes_getservbyname (service, "tcp");
1081 if (servent)
1083 addr.sin_port = servent->s_port;
1084 found_port = 1;
1087 #endif
1088 if (! found_port)
1090 servent = getservbyname (service, "tcp");
1091 if (servent)
1093 addr.sin_port = servent->s_port;
1095 else
1097 /** "kpop" service is never used: look for 20060515 to see why **/
1098 #ifdef KERBEROS
1099 addr.sin_port = htons ((flags & POP_NO_KERBEROS) ?
1100 POP_PORT : KPOP_PORT);
1101 #else
1102 addr.sin_port = htons (POP_PORT);
1103 #endif
1107 #define POP_SOCKET_ERROR "Could not create socket for POP connection: "
1109 sock = socket (PF_INET, SOCK_STREAM, 0);
1110 if (sock < 0)
1112 strcpy (pop_error, POP_SOCKET_ERROR);
1113 strncat (pop_error, strerror (errno),
1114 ERROR_MAX - sizeof (POP_SOCKET_ERROR));
1115 return (-1);
1121 hostent = gethostbyname (host);
1122 try_count++;
1123 if ((! hostent) && ((h_errno != TRY_AGAIN) || (try_count == 5)))
1125 strcpy (pop_error, "Could not determine POP server's address");
1126 return (-1);
1128 } while (! hostent);
1130 while (*hostent->h_addr_list)
1132 bcopy (*hostent->h_addr_list, (char *) &addr.sin_addr,
1133 hostent->h_length);
1134 if (! connect (sock, (struct sockaddr *) &addr, sizeof (addr)))
1135 break;
1136 hostent->h_addr_list++;
1139 #define CONNECT_ERROR "Could not connect to POP server: "
1141 if (! *hostent->h_addr_list)
1143 CLOSESOCKET (sock);
1144 strcpy (pop_error, CONNECT_ERROR);
1145 strncat (pop_error, strerror (errno),
1146 ERROR_MAX - sizeof (CONNECT_ERROR));
1147 return (-1);
1151 #ifdef KERBEROS
1152 #define KRB_ERROR "Kerberos error connecting to POP server: "
1153 if (! (flags & POP_NO_KERBEROS))
1155 #ifdef KERBEROS5
1156 if ((rem = krb5_init_context (&kcontext)))
1158 krb5error:
1159 if (auth_context)
1160 krb5_auth_con_free (kcontext, auth_context);
1161 if (kcontext)
1162 krb5_free_context (kcontext);
1163 strcpy (pop_error, KRB_ERROR);
1164 strncat (pop_error, error_message (rem),
1165 ERROR_MAX - sizeof(KRB_ERROR));
1166 CLOSESOCKET (sock);
1167 return (-1);
1170 if ((rem = krb5_auth_con_init (kcontext, &auth_context)))
1171 goto krb5error;
1173 if (rem = krb5_cc_default (kcontext, &ccdef))
1174 goto krb5error;
1176 if (rem = krb5_cc_get_principal (kcontext, ccdef, &client))
1177 goto krb5error;
1179 for (cp = hostent->h_name; *cp; cp++)
1181 if (isupper (*cp))
1183 *cp = tolower (*cp);
1187 if (rem = krb5_sname_to_principal (kcontext, hostent->h_name,
1188 POP_SERVICE, FALSE, &server))
1189 goto krb5error;
1191 rem = krb5_sendauth (kcontext, &auth_context,
1192 (krb5_pointer) &sock, "KPOPV1.0", client, server,
1193 AP_OPTS_MUTUAL_REQUIRED,
1194 0, /* no checksum */
1195 0, /* no creds, use ccache instead */
1196 ccdef,
1197 &err_ret,
1198 0, /* don't need subsession key */
1199 0); /* don't need reply */
1200 krb5_free_principal (kcontext, server);
1201 if (rem)
1203 strcpy (pop_error, KRB_ERROR);
1204 strncat (pop_error, error_message (rem),
1205 ERROR_MAX - sizeof (KRB_ERROR));
1206 #if defined HAVE_KRB5_ERROR_TEXT
1207 if (err_ret && err_ret->text.length)
1209 strncat (pop_error, " [server says '",
1210 ERROR_MAX - strlen (pop_error) - 1);
1211 strncat (pop_error, err_ret->text.data,
1212 min (ERROR_MAX - strlen (pop_error) - 1,
1213 err_ret->text.length));
1214 strncat (pop_error, "']",
1215 ERROR_MAX - strlen (pop_error) - 1);
1217 #elif defined HAVE_KRB5_ERROR_E_TEXT
1218 if (err_ret && err_ret->e_text && strlen(*err_ret->e_text))
1220 strncat (pop_error, " [server says '",
1221 ERROR_MAX - strlen (pop_error) - 1);
1222 strncat (pop_error, *err_ret->e_text,
1223 ERROR_MAX - strlen (pop_error) - 1);
1224 strncat (pop_error, "']",
1225 ERROR_MAX - strlen (pop_error) - 1);
1227 #endif
1228 if (err_ret)
1229 krb5_free_error (kcontext, err_ret);
1230 krb5_auth_con_free (kcontext, auth_context);
1231 krb5_free_context (kcontext);
1233 CLOSESOCKET (sock);
1234 return (-1);
1236 #else /* ! KERBEROS5 */
1237 ticket = (KTEXT) malloc (sizeof (KTEXT_ST));
1238 realhost = strdup (hostent->h_name);
1239 rem = krb_sendauth (0L, sock, ticket, "pop", realhost,
1240 (char *) krb_realmofhost (realhost),
1241 (unsigned long) 0, &msg_data, &cred, schedule,
1242 (struct sockaddr_in *) 0,
1243 (struct sockaddr_in *) 0,
1244 "KPOPV0.1");
1245 free ((char *) ticket);
1246 free (realhost);
1247 if (rem != KSUCCESS)
1249 strcpy (pop_error, KRB_ERROR);
1250 strncat (pop_error, krb_err_txt[rem],
1251 ERROR_MAX - sizeof (KRB_ERROR));
1252 CLOSESOCKET (sock);
1253 return (-1);
1255 #endif /* KERBEROS5 */
1257 #endif /* KERBEROS */
1259 return (sock);
1260 } /* socket_connection */
1263 * Function: pop_getline
1265 * Purpose: Get a line of text from the connection and return a
1266 * pointer to it. The carriage return and linefeed at the end of
1267 * the line are stripped, but periods at the beginnings of lines
1268 * are NOT dealt with in any special way.
1270 * Arguments:
1271 * server The server from which to get the line of text.
1273 * Returns: The number of characters in the line, which is returned in
1274 * LINE, not including the final null. A return value of 0
1275 * indicates a blank line. A negative return value indicates an
1276 * error (in which case the contents of LINE are undefined. In
1277 * case of error, an error message is copied into pop_error.
1279 * Notes: The line returned is overwritten with each call to pop_getline.
1281 * Side effects: Closes the connection on error.
1283 * THE RETURNED LINE MAY CONTAIN EMBEDDED NULLS!
1285 static int
1286 pop_getline (server, line)
1287 popserver server;
1288 char **line;
1290 #define GETLINE_ERROR "Error reading from server: "
1292 int ret;
1293 int search_offset = 0;
1295 if (server->data)
1297 char *cp = find_crlf (server->buffer + server->buffer_index,
1298 server->data);
1299 if (cp)
1301 int found;
1302 int data_used;
1304 found = server->buffer_index;
1305 data_used = (cp + 2) - server->buffer - found;
1307 *cp = '\0'; /* terminate the string to be returned */
1308 server->data -= data_used;
1309 server->buffer_index += data_used;
1311 if (pop_debug)
1312 /* Embedded nulls will truncate this output prematurely,
1313 but that's OK because it's just for debugging anyway. */
1314 fprintf (stderr, "<<< %s\n", server->buffer + found);
1315 *line = server->buffer + found;
1316 return (data_used - 2);
1318 else
1320 bcopy (server->buffer + server->buffer_index,
1321 server->buffer, server->data);
1322 /* Record the fact that we've searched the data already in
1323 the buffer for a CRLF, so that when we search below, we
1324 don't have to search the same data twice. There's a "-
1325 1" here to account for the fact that the last character
1326 of the data we have may be the CR of a CRLF pair, of
1327 which we haven't read the second half yet, so we may have
1328 to search it again when we read more data. */
1329 search_offset = server->data - 1;
1330 server->buffer_index = 0;
1333 else
1335 server->buffer_index = 0;
1338 while (1)
1340 /* There's a "- 1" here to leave room for the null that we put
1341 at the end of the read data below. We put the null there so
1342 that find_crlf knows where to stop when we call it. */
1343 if (server->data == server->buffer_size - 1)
1345 server->buffer_size += GETLINE_INCR;
1346 server->buffer = (char *)realloc (server->buffer, server->buffer_size);
1347 if (! server->buffer)
1349 strcpy (pop_error, "Out of memory in pop_getline");
1350 pop_trash (server);
1351 return (-1);
1354 ret = RECV (server->file, server->buffer + server->data,
1355 server->buffer_size - server->data - 1, 0);
1356 if (ret < 0)
1358 strcpy (pop_error, GETLINE_ERROR);
1359 strncat (pop_error, strerror (errno),
1360 ERROR_MAX - sizeof (GETLINE_ERROR));
1361 pop_trash (server);
1362 return (-1);
1364 else if (ret == 0)
1366 strcpy (pop_error, "Unexpected EOF from server in pop_getline");
1367 pop_trash (server);
1368 return (-1);
1370 else
1372 char *cp;
1373 server->data += ret;
1374 server->buffer[server->data] = '\0';
1376 cp = find_crlf (server->buffer + search_offset,
1377 server->data - search_offset);
1378 if (cp)
1380 int data_used = (cp + 2) - server->buffer;
1381 *cp = '\0';
1382 server->data -= data_used;
1383 server->buffer_index = data_used;
1385 if (pop_debug)
1386 fprintf (stderr, "<<< %s\n", server->buffer);
1387 *line = server->buffer;
1388 return (data_used - 2);
1390 /* As above, the "- 1" here is to account for the fact that
1391 we may have read a CR without its accompanying LF. */
1392 search_offset += ret - 1;
1396 /* NOTREACHED */
1400 * Function: sendline
1402 * Purpose: Sends a line of text to the POP server. The line of text
1403 * passed into this function should NOT have the carriage return
1404 * and linefeed on the end of it. Periods at beginnings of lines
1405 * will NOT be treated specially by this function.
1407 * Arguments:
1408 * server The server to which to send the text.
1409 * line The line of text to send.
1411 * Return value: Upon successful completion, a value of 0 will be
1412 * returned. Otherwise, a non-zero value will be returned, and
1413 * an error will be copied into pop_error.
1415 * Side effects: Closes the connection on error.
1417 static int
1418 sendline (server, line)
1419 popserver server;
1420 char *line;
1422 #define SENDLINE_ERROR "Error writing to POP server: "
1423 int ret;
1424 char *buf;
1426 /* Combine the string and the CR-LF into one buffer. Otherwise, two
1427 reasonable network stack optimizations, Nagle's algorithm and
1428 delayed acks, combine to delay us a fraction of a second on every
1429 message we send. (Movemail writes line without \r\n, client
1430 kernel sends packet, server kernel delays the ack to see if it
1431 can combine it with data, movemail writes \r\n, client kernel
1432 waits because it has unacked data already in its outgoing queue,
1433 client kernel eventually times out and sends.)
1435 This can be something like 0.2s per command, which can add up
1436 over a few dozen messages, and is a big chunk of the time we
1437 spend fetching mail from a server close by. */
1438 buf = alloca (strlen (line) + 3);
1439 strcpy (buf, line);
1440 strcat (buf, "\r\n");
1441 ret = fullwrite (server->file, buf, strlen (buf));
1443 if (ret < 0)
1445 pop_trash (server);
1446 strcpy (pop_error, SENDLINE_ERROR);
1447 strncat (pop_error, strerror (errno),
1448 ERROR_MAX - sizeof (SENDLINE_ERROR));
1449 return (ret);
1452 if (pop_debug)
1453 fprintf (stderr, ">>> %s\n", line);
1455 return (0);
1459 * Procedure: fullwrite
1461 * Purpose: Just like write, but keeps trying until the entire string
1462 * has been written.
1464 * Return value: Same as write. Pop_error is not set.
1466 static int
1467 fullwrite (fd, buf, nbytes)
1468 int fd;
1469 char *buf;
1470 int nbytes;
1472 char *cp;
1473 int ret = 0;
1475 cp = buf;
1476 while (nbytes && ((ret = SEND (fd, cp, nbytes, 0)) > 0))
1478 cp += ret;
1479 nbytes -= ret;
1482 return (ret);
1486 * Procedure getok
1488 * Purpose: Reads a line from the server. If the return indicator is
1489 * positive, return with a zero exit status. If not, return with
1490 * a negative exit status.
1492 * Arguments:
1493 * server The server to read from.
1495 * Returns: 0 for success, else for failure and puts error in pop_error.
1497 * Side effects: On failure, may make the connection unusable.
1499 static int
1500 getok (server)
1501 popserver server;
1503 char *fromline;
1505 if (pop_getline (server, &fromline) < 0)
1507 return (-1);
1510 if (! strncmp (fromline, "+OK", 3))
1511 return (0);
1512 else if (! strncmp (fromline, "-ERR", 4))
1514 strncpy (pop_error, fromline, ERROR_MAX);
1515 pop_error[ERROR_MAX-1] = '\0';
1516 return (-1);
1518 else
1520 strcpy (pop_error,
1521 "Unexpected response from server; expecting +OK or -ERR");
1522 pop_trash (server);
1523 return (-1);
1527 #if 0
1529 * Function: gettermination
1531 * Purpose: Gets the next line and verifies that it is a termination
1532 * line (nothing but a dot).
1534 * Return value: 0 on success, non-zero with pop_error set on error.
1536 * Side effects: Closes the connection on error.
1538 static int
1539 gettermination (server)
1540 popserver server;
1542 char *fromserver;
1544 if (pop_getline (server, &fromserver) < 0)
1545 return (-1);
1547 if (strcmp (fromserver, "."))
1549 strcpy (pop_error,
1550 "Unexpected response from server in gettermination");
1551 pop_trash (server);
1552 return (-1);
1555 return (0);
1557 #endif
1560 * Function pop_close
1562 * Purpose: Close a pop connection, sending a "RSET" command to try to
1563 * preserve any changes that were made and a "QUIT" command to
1564 * try to get the server to quit, but ignoring any responses that
1565 * are received.
1567 * Side effects: The server is unusable after this function returns.
1568 * Changes made to the maildrop since the session was started (or
1569 * since the last pop_reset) may be lost.
1571 void
1572 pop_close (server)
1573 popserver server;
1575 pop_trash (server);
1576 free ((char *) server);
1578 return;
1582 * Function: pop_trash
1584 * Purpose: Like pop_close or pop_quit, but doesn't deallocate the
1585 * memory associated with the server. It is valid to call
1586 * pop_close or pop_quit after this function has been called.
1588 static void
1589 pop_trash (server)
1590 popserver server;
1592 if (server->file >= 0)
1594 /* avoid recursion; sendline can call pop_trash */
1595 if (server->trash_started)
1596 return;
1597 server->trash_started = 1;
1599 sendline (server, "RSET");
1600 sendline (server, "QUIT");
1602 CLOSESOCKET (server->file);
1603 server->file = -1;
1604 if (server->buffer)
1606 free (server->buffer);
1607 server->buffer = 0;
1611 #ifdef WINDOWSNT
1612 if (have_winsock)
1613 WSACleanup ();
1614 #endif
1617 /* Return a pointer to the first CRLF in IN_STRING, which can contain
1618 embedded nulls and has LEN characters in it not including the final
1619 null, or 0 if it does not contain one. */
1621 static char *
1622 find_crlf (in_string, len)
1623 char *in_string;
1624 int len;
1626 while (len--)
1628 if (*in_string == '\r')
1630 if (*++in_string == '\n')
1631 return (in_string - 1);
1633 else
1634 in_string++;
1636 return (0);
1639 #endif /* MAIL_USE_POP */
1641 /* arch-tag: ceb37041-b7ad-49a8-a63d-286618b8367d
1642 (do not change this comment) */