(change-log-goto-source): Avoid wrong-type-argument
[emacs.git] / lib-src / pop.c
blob76cd2fb57925c077a41cfb757d5443dd877f13c4
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.
5 Author: Jonathan Kamens <jik@security.ov.com>
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #else
26 #define MAIL_USE_POP
27 #endif
29 #ifdef MAIL_USE_POP
31 #include <sys/types.h>
32 #ifdef WINDOWSNT
33 #include "ntlib.h"
34 #include <winsock.h>
35 #undef SOCKET_ERROR
36 #define RECV(s,buf,len,flags) recv(s,buf,len,flags)
37 #define SEND(s,buf,len,flags) send(s,buf,len,flags)
38 #define CLOSESOCKET(s) closesocket(s)
39 #else
40 #include <netinet/in.h>
41 #include <sys/socket.h>
42 #define RECV(s,buf,len,flags) read(s,buf,len)
43 #define SEND(s,buf,len,flags) write(s,buf,len)
44 #define CLOSESOCKET(s) close(s)
45 #endif
46 #include <pop.h>
48 #ifdef sun
49 #include <malloc.h>
50 #endif /* sun */
52 #ifdef HESIOD
53 #include <hesiod.h>
55 * It really shouldn't be necessary to put this declaration here, but
56 * the version of hesiod.h that Athena has installed in release 7.2
57 * doesn't declare this function; I don't know if the 7.3 version of
58 * hesiod.h does.
60 extern struct servent *hes_getservbyname (/* char *, char * */);
61 #endif
63 #include <pwd.h>
64 #include <netdb.h>
65 #include <errno.h>
66 #include <stdio.h>
67 #ifdef STDC_HEADERS
68 #include <string.h>
69 #define index strchr
70 #endif
71 #ifdef HAVE_UNISTD_H
72 #include <unistd.h>
73 #endif
75 #ifdef KERBEROS
76 # ifdef HAVE_KRB5_H
77 # include <krb5.h>
78 # endif
79 # ifdef HAVE_KRB_H
80 # include <krb.h>
81 # else
82 # ifdef HAVE_KERBEROSIV_KRB_H
83 # include <kerberosIV/krb.h>
84 # else
85 # ifdef HAVE_KERBEROS_KRB_H
86 # include <kerberos/krb.h>
87 # endif
88 # endif
89 # endif
90 # ifdef HAVE_COM_ERR_H
91 # include <com_err.h>
92 # endif
93 #endif /* KERBEROS */
95 #ifdef KERBEROS
96 #ifndef KERBEROS5
97 extern int krb_sendauth (/* long, int, KTEXT, char *, char *, char *,
98 u_long, MSG_DAT *, CREDENTIALS *, Key_schedule,
99 struct sockaddr_in *, struct sockaddr_in *,
100 char * */);
101 extern char *krb_realmofhost (/* char * */);
102 #endif /* ! KERBEROS5 */
103 #endif /* KERBEROS */
105 #ifndef WINDOWSNT
106 #if !defined(HAVE_H_ERRNO) || !defined(HAVE_CONFIG_H)
107 extern int h_errno;
108 #endif
109 #endif
111 #ifndef __P
112 # ifdef __STDC__
113 # define __P(a) a
114 # else
115 # define __P(a) ()
116 # endif /* __STDC__ */
117 #endif /* ! __P */
119 static int socket_connection __P((char *, int));
120 static int pop_getline __P((popserver, char **));
121 static int sendline __P((popserver, char *));
122 static int fullwrite __P((int, char *, int));
123 static int getok __P((popserver));
124 #if 0
125 static int gettermination __P((popserver));
126 #endif
127 static void pop_trash __P((popserver));
128 static char *find_crlf __P((char *, int));
130 #define ERROR_MAX 160 /* a pretty arbitrary size, but needs
131 to be bigger than the original
132 value of 80 */
133 #define POP_PORT 110
134 #define KPOP_PORT 1109
135 #define POP_SERVICE "pop3" /* we don't want the POP2 port! */
136 #ifdef KERBEROS
137 #define KPOP_SERVICE "kpop" /* never used: look for 20060515 to see why */
138 #endif
140 char pop_error[ERROR_MAX];
141 int pop_debug = 0;
143 #ifndef min
144 #define min(a,b) (((a) < (b)) ? (a) : (b))
145 #endif
148 * Function: pop_open (char *host, char *username, char *password,
149 * int flags)
151 * Purpose: Establishes a connection with a post-office server, and
152 * completes the authorization portion of the session.
154 * Arguments:
155 * host The server host with which the connection should be
156 * established. Optional. If omitted, internal
157 * heuristics will be used to determine the server host,
158 * if possible.
159 * username
160 * The username of the mail-drop to access. Optional.
161 * If omitted, internal heuristics will be used to
162 * determine the username, if possible.
163 * password
164 * The password to use for authorization. If omitted,
165 * internal heuristics will be used to determine the
166 * password, if possible.
167 * flags A bit mask containing flags controlling certain
168 * functions of the routine. Valid flags are defined in
169 * the file pop.h
171 * Return value: Upon successful establishment of a connection, a
172 * non-null popserver will be returned. Otherwise, null will be
173 * returned, and the string variable pop_error will contain an
174 * explanation of the error.
176 popserver
177 pop_open (host, username, password, flags)
178 char *host;
179 char *username;
180 char *password;
181 int flags;
183 int sock;
184 popserver server;
186 /* Determine the user name */
187 if (! username)
189 username = getenv ("USER");
190 if (! (username && *username))
192 username = getlogin ();
193 if (! (username && *username))
195 struct passwd *passwd;
196 passwd = getpwuid (getuid ());
197 if (passwd && passwd->pw_name && *passwd->pw_name)
199 username = passwd->pw_name;
201 else
203 strcpy (pop_error, "Could not determine username");
204 return (0);
211 * Determine the mail host.
214 if (! host)
216 host = getenv ("MAILHOST");
219 #ifdef HESIOD
220 if ((! host) && (! (flags & POP_NO_HESIOD)))
222 struct hes_postoffice *office;
223 office = hes_getmailhost (username);
224 if (office && office->po_type && (! strcmp (office->po_type, "POP"))
225 && office->po_name && *office->po_name && office->po_host
226 && *office->po_host)
228 host = office->po_host;
229 username = office->po_name;
232 #endif
234 #ifdef MAILHOST
235 if (! host)
237 host = MAILHOST;
239 #endif
241 if (! host)
243 strcpy (pop_error, "Could not determine POP server");
244 return (0);
247 /* Determine the password */
248 #ifdef KERBEROS
249 #define DONT_NEED_PASSWORD (! (flags & POP_NO_KERBEROS))
250 #else
251 #define DONT_NEED_PASSWORD 0
252 #endif
254 if ((! password) && (! DONT_NEED_PASSWORD))
256 if (! (flags & POP_NO_GETPASS))
258 password = getpass ("Enter POP password:");
260 if (! password)
262 strcpy (pop_error, "Could not determine POP password");
263 return (0);
266 if (password) /* always true, detected 20060515 */
267 flags |= POP_NO_KERBEROS;
268 else
269 password = username; /* dead code, detected 20060515 */
270 /** "kpop" service is never used: look for 20060515 to see why **/
272 sock = socket_connection (host, flags);
273 if (sock == -1)
274 return (0);
276 server = (popserver) malloc (sizeof (struct _popserver));
277 if (! server)
279 strcpy (pop_error, "Out of memory in pop_open");
280 return (0);
282 server->buffer = (char *) malloc (GETLINE_MIN);
283 if (! server->buffer)
285 strcpy (pop_error, "Out of memory in pop_open");
286 free ((char *) server);
287 return (0);
290 server->file = sock;
291 server->data = 0;
292 server->buffer_index = 0;
293 server->buffer_size = GETLINE_MIN;
294 server->in_multi = 0;
295 server->trash_started = 0;
297 if (getok (server))
298 return (0);
301 * I really shouldn't use the pop_error variable like this, but....
303 if (strlen (username) > ERROR_MAX - 6)
305 pop_close (server);
306 strcpy (pop_error,
307 "Username too long; recompile pop.c with larger ERROR_MAX");
308 return (0);
310 sprintf (pop_error, "USER %s", username);
312 if (sendline (server, pop_error) || getok (server))
314 return (0);
317 if (strlen (password) > ERROR_MAX - 6)
319 pop_close (server);
320 strcpy (pop_error,
321 "Password too long; recompile pop.c with larger ERROR_MAX");
322 return (0);
324 sprintf (pop_error, "PASS %s", password);
326 if (sendline (server, pop_error) || getok (server))
328 return (0);
331 return (server);
335 * Function: pop_stat
337 * Purpose: Issue the STAT command to the server and return (in the
338 * value parameters) the number of messages in the maildrop and
339 * the total size of the maildrop.
341 * Return value: 0 on success, or non-zero with an error in pop_error
342 * in failure.
344 * Side effects: On failure, may make further operations on the
345 * connection impossible.
348 pop_stat (server, count, size)
349 popserver server;
350 int *count;
351 int *size;
353 char *fromserver;
354 char *end_ptr;
356 if (server->in_multi)
358 strcpy (pop_error, "In multi-line query in pop_stat");
359 return (-1);
362 if (sendline (server, "STAT") || (pop_getline (server, &fromserver) < 0))
363 return (-1);
365 if (strncmp (fromserver, "+OK ", 4))
367 if (0 == strncmp (fromserver, "-ERR", 4))
369 strncpy (pop_error, fromserver, ERROR_MAX);
371 else
373 strcpy (pop_error,
374 "Unexpected response from POP server in pop_stat");
375 pop_trash (server);
377 return (-1);
380 errno = 0;
381 *count = strtol (&fromserver[4], &end_ptr, 10);
382 /* Check validity of string-to-integer conversion. */
383 if (fromserver + 4 == end_ptr || *end_ptr != ' ' || errno)
385 strcpy (pop_error, "Unexpected response from POP server in pop_stat");
386 pop_trash (server);
387 return (-1);
390 fromserver = end_ptr;
392 errno = 0;
393 *size = strtol (fromserver + 1, &end_ptr, 10);
394 if (fromserver + 1 == end_ptr || errno)
396 strcpy (pop_error, "Unexpected response from POP server in pop_stat");
397 pop_trash (server);
398 return (-1);
401 return (0);
405 * Function: pop_list
407 * Purpose: Performs the POP "list" command and returns (in value
408 * parameters) two malloc'd zero-terminated arrays -- one of
409 * message IDs, and a parallel one of sizes.
411 * Arguments:
412 * server The pop connection to talk to.
413 * message The number of the one message about which to get
414 * information, or 0 to get information about all
415 * messages.
417 * Return value: 0 on success, non-zero with error in pop_error on
418 * failure.
420 * Side effects: On failure, may make further operations on the
421 * connection impossible.
424 pop_list (server, message, IDs, sizes)
425 popserver server;
426 int message;
427 int **IDs;
428 int **sizes;
430 int how_many, i;
431 char *fromserver;
433 if (server->in_multi)
435 strcpy (pop_error, "In multi-line query in pop_list");
436 return (-1);
439 if (message)
440 how_many = 1;
441 else
443 int count, size;
444 if (pop_stat (server, &count, &size))
445 return (-1);
446 how_many = count;
449 *IDs = (int *) malloc ((how_many + 1) * sizeof (int));
450 *sizes = (int *) malloc ((how_many + 1) * sizeof (int));
451 if (! (*IDs && *sizes))
453 strcpy (pop_error, "Out of memory in pop_list");
454 return (-1);
457 if (message)
459 sprintf (pop_error, "LIST %d", message);
460 if (sendline (server, pop_error))
462 free ((char *) *IDs);
463 free ((char *) *sizes);
464 return (-1);
466 if (pop_getline (server, &fromserver) < 0)
468 free ((char *) *IDs);
469 free ((char *) *sizes);
470 return (-1);
472 if (strncmp (fromserver, "+OK ", 4))
474 if (! strncmp (fromserver, "-ERR", 4))
475 strncpy (pop_error, fromserver, ERROR_MAX);
476 else
478 strcpy (pop_error,
479 "Unexpected response from server in pop_list");
480 pop_trash (server);
482 free ((char *) *IDs);
483 free ((char *) *sizes);
484 return (-1);
486 (*IDs)[0] = atoi (&fromserver[4]);
487 fromserver = index (&fromserver[4], ' ');
488 if (! fromserver)
490 strcpy (pop_error,
491 "Badly formatted response from server in pop_list");
492 pop_trash (server);
493 free ((char *) *IDs);
494 free ((char *) *sizes);
495 return (-1);
497 (*sizes)[0] = atoi (fromserver);
498 (*IDs)[1] = (*sizes)[1] = 0;
499 return (0);
501 else
503 if (pop_multi_first (server, "LIST", &fromserver))
505 free ((char *) *IDs);
506 free ((char *) *sizes);
507 return (-1);
509 for (i = 0; i < how_many; i++)
511 if (pop_multi_next (server, &fromserver) <= 0)
513 free ((char *) *IDs);
514 free ((char *) *sizes);
515 return (-1);
517 (*IDs)[i] = atoi (fromserver);
518 fromserver = index (fromserver, ' ');
519 if (! fromserver)
521 strcpy (pop_error,
522 "Badly formatted response from server in pop_list");
523 free ((char *) *IDs);
524 free ((char *) *sizes);
525 pop_trash (server);
526 return (-1);
528 (*sizes)[i] = atoi (fromserver);
530 if (pop_multi_next (server, &fromserver) < 0)
532 free ((char *) *IDs);
533 free ((char *) *sizes);
534 return (-1);
536 else if (fromserver)
538 strcpy (pop_error,
539 "Too many response lines from server in pop_list");
540 free ((char *) *IDs);
541 free ((char *) *sizes);
542 return (-1);
544 (*IDs)[i] = (*sizes)[i] = 0;
545 return (0);
550 * Function: pop_retrieve
552 * Purpose: Retrieve a specified message from the maildrop.
554 * Arguments:
555 * server The server to retrieve from.
556 * message The message number to retrieve.
557 * markfrom
558 * If true, then mark the string "From " at the beginning
559 * of lines with '>'.
560 * msg_buf Output parameter to which a buffer containing the
561 * message is assigned.
563 * Return value: The number of bytes in msg_buf, which may contain
564 * embedded nulls, not including its final null, or -1 on error
565 * with pop_error set.
567 * Side effects: May kill connection on error.
570 pop_retrieve (server, message, markfrom, msg_buf)
571 popserver server;
572 int message;
573 int markfrom;
574 char **msg_buf;
576 int *IDs, *sizes, bufsize, fromcount = 0, cp = 0;
577 char *ptr, *fromserver;
578 int ret;
580 if (server->in_multi)
582 strcpy (pop_error, "In multi-line query in pop_retrieve");
583 return (-1);
586 if (pop_list (server, message, &IDs, &sizes))
587 return (-1);
589 if (pop_retrieve_first (server, message, &fromserver))
591 return (-1);
595 * The "5" below is an arbitrary constant -- I assume that if
596 * there are "From" lines in the text to be marked, there
597 * probably won't be more than 5 of them. If there are, I
598 * allocate more space for them below.
600 bufsize = sizes[0] + (markfrom ? 5 : 0);
601 ptr = (char *)malloc (bufsize);
602 free ((char *) IDs);
603 free ((char *) sizes);
605 if (! ptr)
607 strcpy (pop_error, "Out of memory in pop_retrieve");
608 pop_retrieve_flush (server);
609 return (-1);
612 while ((ret = pop_retrieve_next (server, &fromserver)) >= 0)
614 if (! fromserver)
616 ptr[cp] = '\0';
617 *msg_buf = ptr;
618 return (cp);
620 if (markfrom && fromserver[0] == 'F' && fromserver[1] == 'r' &&
621 fromserver[2] == 'o' && fromserver[3] == 'm' &&
622 fromserver[4] == ' ')
624 if (++fromcount == 5)
626 bufsize += 5;
627 ptr = (char *)realloc (ptr, bufsize);
628 if (! ptr)
630 strcpy (pop_error, "Out of memory in pop_retrieve");
631 pop_retrieve_flush (server);
632 return (-1);
634 fromcount = 0;
636 ptr[cp++] = '>';
638 bcopy (fromserver, &ptr[cp], ret);
639 cp += ret;
640 ptr[cp++] = '\n';
643 free (ptr);
644 return (-1);
648 pop_retrieve_first (server, message, response)
649 popserver server;
650 int message;
651 char **response;
653 sprintf (pop_error, "RETR %d", message);
654 return (pop_multi_first (server, pop_error, response));
658 Returns a negative number on error, 0 to indicate that the data has
659 all been read (i.e., the server has returned a "." termination
660 line), or a positive number indicating the number of bytes in the
661 returned buffer (which is null-terminated and may contain embedded
662 nulls, but the returned bytecount doesn't include the final null).
666 pop_retrieve_next (server, line)
667 popserver server;
668 char **line;
670 return (pop_multi_next (server, line));
674 pop_retrieve_flush (server)
675 popserver server;
677 return (pop_multi_flush (server));
681 pop_top_first (server, message, lines, response)
682 popserver server;
683 int message, lines;
684 char **response;
686 sprintf (pop_error, "TOP %d %d", message, lines);
687 return (pop_multi_first (server, pop_error, response));
691 Returns a negative number on error, 0 to indicate that the data has
692 all been read (i.e., the server has returned a "." termination
693 line), or a positive number indicating the number of bytes in the
694 returned buffer (which is null-terminated and may contain embedded
695 nulls, but the returned bytecount doesn't include the final null).
699 pop_top_next (server, line)
700 popserver server;
701 char **line;
703 return (pop_multi_next (server, line));
707 pop_top_flush (server)
708 popserver server;
710 return (pop_multi_flush (server));
714 pop_multi_first (server, command, response)
715 popserver server;
716 char *command;
717 char **response;
719 if (server->in_multi)
721 strcpy (pop_error,
722 "Already in multi-line query in pop_multi_first");
723 return (-1);
726 if (sendline (server, command) || (pop_getline (server, response) < 0))
728 return (-1);
731 if (0 == strncmp (*response, "-ERR", 4))
733 strncpy (pop_error, *response, ERROR_MAX);
734 return (-1);
736 else if (0 == strncmp (*response, "+OK", 3))
738 for (*response += 3; **response == ' '; (*response)++) /* empty */;
739 server->in_multi = 1;
740 return (0);
742 else
744 strcpy (pop_error,
745 "Unexpected response from server in pop_multi_first");
746 return (-1);
751 Read the next line of data from SERVER and place a pointer to it
752 into LINE. Return -1 on error, 0 if there are no more lines to read
753 (i.e., the server has returned a line containing only "."), or a
754 positive number indicating the number of bytes in the LINE buffer
755 (not including the final null). The data in that buffer may contain
756 embedded nulls, but does not contain the final CRLF. When returning
757 0, LINE is set to null. */
760 pop_multi_next (server, line)
761 popserver server;
762 char **line;
764 char *fromserver;
765 int ret;
767 if (! server->in_multi)
769 strcpy (pop_error, "Not in multi-line query in pop_multi_next");
770 return (-1);
773 if ((ret = pop_getline (server, &fromserver)) < 0)
775 return (-1);
778 if (fromserver[0] == '.')
780 if (! fromserver[1])
782 *line = 0;
783 server->in_multi = 0;
784 return (0);
786 else
788 *line = fromserver + 1;
789 return (ret - 1);
792 else
794 *line = fromserver;
795 return (ret);
800 pop_multi_flush (server)
801 popserver server;
803 char *line;
804 int ret;
806 if (! server->in_multi)
808 return (0);
811 while ((ret = pop_multi_next (server, &line)))
813 if (ret < 0)
814 return (-1);
817 return (0);
820 /* Function: pop_delete
822 * Purpose: Delete a specified message.
824 * Arguments:
825 * server Server from which to delete the message.
826 * message Message to delete.
828 * Return value: 0 on success, non-zero with error in pop_error
829 * otherwise.
832 pop_delete (server, message)
833 popserver server;
834 int message;
836 if (server->in_multi)
838 strcpy (pop_error, "In multi-line query in pop_delete");
839 return (-1);
842 sprintf (pop_error, "DELE %d", message);
844 if (sendline (server, pop_error) || getok (server))
845 return (-1);
847 return (0);
851 * Function: pop_noop
853 * Purpose: Send a noop command to the server.
855 * Argument:
856 * server The server to send to.
858 * Return value: 0 on success, non-zero with error in pop_error
859 * otherwise.
861 * Side effects: Closes connection on error.
864 pop_noop (server)
865 popserver server;
867 if (server->in_multi)
869 strcpy (pop_error, "In multi-line query in pop_noop");
870 return (-1);
873 if (sendline (server, "NOOP") || getok (server))
874 return (-1);
876 return (0);
880 * Function: pop_last
882 * Purpose: Find out the highest seen message from the server.
884 * Arguments:
885 * server The server.
887 * Return value: If successful, the highest seen message, which is
888 * greater than or equal to 0. Otherwise, a negative number with
889 * the error explained in pop_error.
891 * Side effects: Closes the connection on error.
894 pop_last (server)
895 popserver server;
897 char *fromserver;
899 if (server->in_multi)
901 strcpy (pop_error, "In multi-line query in pop_last");
902 return (-1);
905 if (sendline (server, "LAST"))
906 return (-1);
908 if (pop_getline (server, &fromserver) < 0)
909 return (-1);
911 if (! strncmp (fromserver, "-ERR", 4))
913 strncpy (pop_error, fromserver, ERROR_MAX);
914 return (-1);
916 else if (strncmp (fromserver, "+OK ", 4))
918 strcpy (pop_error, "Unexpected response from server in pop_last");
919 pop_trash (server);
920 return (-1);
922 else
924 char *end_ptr;
925 int count;
926 errno = 0;
927 count = strtol (&fromserver[4], &end_ptr, 10);
928 if (fromserver + 4 == end_ptr || errno)
930 strcpy (pop_error, "Unexpected response from server in pop_last");
931 pop_trash (server);
932 return (-1);
934 return count;
939 * Function: pop_reset
941 * Purpose: Reset the server to its initial connect state
943 * Arguments:
944 * server The server.
946 * Return value: 0 for success, non-0 with error in pop_error
947 * otherwise.
949 * Side effects: Closes the connection on error.
952 pop_reset (server)
953 popserver server;
955 if (pop_retrieve_flush (server))
957 return (-1);
960 if (sendline (server, "RSET") || getok (server))
961 return (-1);
963 return (0);
967 * Function: pop_quit
969 * Purpose: Quit the connection to the server,
971 * Arguments:
972 * server The server to quit.
974 * Return value: 0 for success, non-zero otherwise with error in
975 * pop_error.
977 * Side Effects: The popserver passed in is unusable after this
978 * function is called, even if an error occurs.
981 pop_quit (server)
982 popserver server;
984 int ret = 0;
986 if (server->file >= 0)
988 if (pop_retrieve_flush (server))
990 ret = -1;
993 if (sendline (server, "QUIT") || getok (server))
995 ret = -1;
998 close (server->file);
1001 free (server->buffer);
1002 free ((char *) server);
1004 return (ret);
1007 #ifdef WINDOWSNT
1008 static int have_winsock = 0;
1009 #endif
1012 * Function: socket_connection
1014 * Purpose: Opens the network connection with the mail host, without
1015 * doing any sort of I/O with it or anything.
1017 * Arguments:
1018 * host The host to which to connect.
1019 * flags Option flags.
1021 * Return value: A file descriptor indicating the connection, or -1
1022 * indicating failure, in which case an error has been copied
1023 * into pop_error.
1025 static int
1026 socket_connection (host, flags)
1027 char *host;
1028 int flags;
1030 #ifdef HAVE_GETADDRINFO
1031 struct addrinfo *res, *it;
1032 struct addrinfo hints;
1033 int ret;
1034 #else /* !HAVE_GETADDRINFO */
1035 struct hostent *hostent;
1036 #endif
1037 struct servent *servent;
1038 struct sockaddr_in addr;
1039 char found_port = 0;
1040 char *service;
1041 int sock;
1042 char *realhost;
1043 #ifdef KERBEROS
1044 #ifdef KERBEROS5
1045 krb5_error_code rem;
1046 krb5_context kcontext = 0;
1047 krb5_auth_context auth_context = 0;
1048 krb5_ccache ccdef;
1049 krb5_principal client, server;
1050 krb5_error *err_ret;
1051 register char *cp;
1052 #else
1053 KTEXT ticket;
1054 MSG_DAT msg_data;
1055 CREDENTIALS cred;
1056 Key_schedule schedule;
1057 int rem;
1058 #endif /* KERBEROS5 */
1059 #endif /* KERBEROS */
1061 int try_count = 0;
1062 int connect_ok;
1064 #ifdef WINDOWSNT
1066 WSADATA winsockData;
1067 if (WSAStartup (0x101, &winsockData) == 0)
1068 have_winsock = 1;
1070 #endif
1072 bzero ((char *) &addr, sizeof (addr));
1073 addr.sin_family = AF_INET;
1075 /** "kpop" service is never used: look for 20060515 to see why **/
1076 #ifdef KERBEROS
1077 service = (flags & POP_NO_KERBEROS) ? POP_SERVICE : KPOP_SERVICE;
1078 #else
1079 service = POP_SERVICE;
1080 #endif
1082 #ifdef HESIOD
1083 if (! (flags & POP_NO_HESIOD))
1085 servent = hes_getservbyname (service, "tcp");
1086 if (servent)
1088 addr.sin_port = servent->s_port;
1089 found_port = 1;
1092 #endif
1093 if (! found_port)
1095 servent = getservbyname (service, "tcp");
1096 if (servent)
1098 addr.sin_port = servent->s_port;
1100 else
1102 /** "kpop" service is never used: look for 20060515 to see why **/
1103 #ifdef KERBEROS
1104 addr.sin_port = htons ((flags & POP_NO_KERBEROS) ?
1105 POP_PORT : KPOP_PORT);
1106 #else
1107 addr.sin_port = htons (POP_PORT);
1108 #endif
1112 #define POP_SOCKET_ERROR "Could not create socket for POP connection: "
1114 sock = socket (PF_INET, SOCK_STREAM, 0);
1115 if (sock < 0)
1117 strcpy (pop_error, POP_SOCKET_ERROR);
1118 strncat (pop_error, strerror (errno),
1119 ERROR_MAX - sizeof (POP_SOCKET_ERROR));
1120 return (-1);
1124 #ifdef HAVE_GETADDRINFO
1125 memset (&hints, 0, sizeof(hints));
1126 hints.ai_socktype = SOCK_STREAM;
1127 hints.ai_flags = AI_CANONNAME;
1128 hints.ai_family = AF_INET;
1131 ret = getaddrinfo (host, service, &hints, &res);
1132 try_count++;
1133 if (ret != 0 && (ret != EAI_AGAIN || try_count == 5))
1135 strcpy (pop_error, "Could not determine POP server's address");
1136 return (-1);
1138 } while (ret != 0);
1140 if (ret == 0)
1142 it = res;
1143 while (it)
1145 if (it->ai_addrlen == sizeof (addr))
1147 struct sockaddr_in *in_a = (struct sockaddr_in *) it->ai_addr;
1148 bcopy (&in_a->sin_addr, (char *) &addr.sin_addr,
1149 sizeof (addr.sin_addr));
1150 if (! connect (sock, (struct sockaddr *) &addr, sizeof (addr)))
1151 break;
1153 it = it->ai_next;
1155 connect_ok = it != NULL;
1156 if (connect_ok)
1158 realhost = alloca (strlen (it->ai_canonname) + 1);
1159 strcpy (realhost, it->ai_canonname);
1161 freeaddrinfo (res);
1163 #else /* !HAVE_GETADDRINFO */
1166 hostent = gethostbyname (host);
1167 try_count++;
1168 if ((! hostent) && ((h_errno != TRY_AGAIN) || (try_count == 5)))
1170 strcpy (pop_error, "Could not determine POP server's address");
1171 return (-1);
1173 } while (! hostent);
1175 while (*hostent->h_addr_list)
1177 bcopy (*hostent->h_addr_list, (char *) &addr.sin_addr,
1178 hostent->h_length);
1179 if (! connect (sock, (struct sockaddr *) &addr, sizeof (addr)))
1180 break;
1181 hostent->h_addr_list++;
1183 connect_ok = *hostent->h_addr_list != NULL;
1184 if (! connect_ok)
1186 realhost = alloca (strlen (hostent->h_name) + 1);
1187 strcpy (realhost, hostent->h_name);
1190 #endif /* !HAVE_GETADDRINFO */
1192 #define CONNECT_ERROR "Could not connect to POP server: "
1194 if (! connect_ok)
1196 CLOSESOCKET (sock);
1197 strcpy (pop_error, CONNECT_ERROR);
1198 strncat (pop_error, strerror (errno),
1199 ERROR_MAX - sizeof (CONNECT_ERROR));
1200 return (-1);
1204 #ifdef KERBEROS
1206 #define KRB_ERROR "Kerberos error connecting to POP server: "
1207 if (! (flags & POP_NO_KERBEROS))
1209 #ifdef KERBEROS5
1210 if ((rem = krb5_init_context (&kcontext)))
1212 krb5error:
1213 if (auth_context)
1214 krb5_auth_con_free (kcontext, auth_context);
1215 if (kcontext)
1216 krb5_free_context (kcontext);
1217 strcpy (pop_error, KRB_ERROR);
1218 strncat (pop_error, error_message (rem),
1219 ERROR_MAX - sizeof(KRB_ERROR));
1220 CLOSESOCKET (sock);
1221 return (-1);
1224 if ((rem = krb5_auth_con_init (kcontext, &auth_context)))
1225 goto krb5error;
1227 if (rem = krb5_cc_default (kcontext, &ccdef))
1228 goto krb5error;
1230 if (rem = krb5_cc_get_principal (kcontext, ccdef, &client))
1231 goto krb5error;
1233 for (cp = realhost; *cp; cp++)
1235 if (isupper (*cp))
1237 *cp = tolower (*cp);
1241 if (rem = krb5_sname_to_principal (kcontext, realhost,
1242 POP_SERVICE, FALSE, &server))
1243 goto krb5error;
1245 rem = krb5_sendauth (kcontext, &auth_context,
1246 (krb5_pointer) &sock, "KPOPV1.0", client, server,
1247 AP_OPTS_MUTUAL_REQUIRED,
1248 0, /* no checksum */
1249 0, /* no creds, use ccache instead */
1250 ccdef,
1251 &err_ret,
1252 0, /* don't need subsession key */
1253 0); /* don't need reply */
1254 krb5_free_principal (kcontext, server);
1255 if (rem)
1257 if (err_ret && err_ret->text.length)
1259 strcpy (pop_error, KRB_ERROR);
1260 strncat (pop_error, error_message (rem),
1261 ERROR_MAX - sizeof (KRB_ERROR));
1262 strncat (pop_error, " [server says '",
1263 ERROR_MAX - strlen (pop_error) - 1);
1264 strncat (pop_error, err_ret->text.data,
1265 min (ERROR_MAX - strlen (pop_error) - 1,
1266 err_ret->text.length));
1267 strncat (pop_error, "']",
1268 ERROR_MAX - strlen (pop_error) - 1);
1270 else
1272 strcpy (pop_error, KRB_ERROR);
1273 strncat (pop_error, error_message (rem),
1274 ERROR_MAX - sizeof (KRB_ERROR));
1276 if (err_ret)
1277 krb5_free_error (kcontext, err_ret);
1278 krb5_auth_con_free (kcontext, auth_context);
1279 krb5_free_context (kcontext);
1281 CLOSESOCKET (sock);
1282 return (-1);
1284 #else /* ! KERBEROS5 */
1285 ticket = (KTEXT) malloc (sizeof (KTEXT_ST));
1286 rem = krb_sendauth (0L, sock, ticket, "pop", realhost,
1287 (char *) krb_realmofhost (realhost),
1288 (unsigned long) 0, &msg_data, &cred, schedule,
1289 (struct sockaddr_in *) 0,
1290 (struct sockaddr_in *) 0,
1291 "KPOPV0.1");
1292 free ((char *) ticket);
1293 if (rem != KSUCCESS)
1295 strcpy (pop_error, KRB_ERROR);
1296 strncat (pop_error, krb_err_txt[rem],
1297 ERROR_MAX - sizeof (KRB_ERROR));
1298 CLOSESOCKET (sock);
1299 return (-1);
1301 #endif /* KERBEROS5 */
1303 #endif /* KERBEROS */
1305 return (sock);
1306 } /* socket_connection */
1309 * Function: pop_getline
1311 * Purpose: Get a line of text from the connection and return a
1312 * pointer to it. The carriage return and linefeed at the end of
1313 * the line are stripped, but periods at the beginnings of lines
1314 * are NOT dealt with in any special way.
1316 * Arguments:
1317 * server The server from which to get the line of text.
1319 * Returns: The number of characters in the line, which is returned in
1320 * LINE, not including the final null. A return value of 0
1321 * indicates a blank line. A negative return value indicates an
1322 * error (in which case the contents of LINE are undefined. In
1323 * case of error, an error message is copied into pop_error.
1325 * Notes: The line returned is overwritten with each call to pop_getline.
1327 * Side effects: Closes the connection on error.
1329 * THE RETURNED LINE MAY CONTAIN EMBEDDED NULLS!
1331 static int
1332 pop_getline (server, line)
1333 popserver server;
1334 char **line;
1336 #define GETLINE_ERROR "Error reading from server: "
1338 int ret;
1339 int search_offset = 0;
1341 if (server->data)
1343 char *cp = find_crlf (server->buffer + server->buffer_index,
1344 server->data);
1345 if (cp)
1347 int found;
1348 int data_used;
1350 found = server->buffer_index;
1351 data_used = (cp + 2) - server->buffer - found;
1353 *cp = '\0'; /* terminate the string to be returned */
1354 server->data -= data_used;
1355 server->buffer_index += data_used;
1357 if (pop_debug)
1358 /* Embedded nulls will truncate this output prematurely,
1359 but that's OK because it's just for debugging anyway. */
1360 fprintf (stderr, "<<< %s\n", server->buffer + found);
1361 *line = server->buffer + found;
1362 return (data_used - 2);
1364 else
1366 bcopy (server->buffer + server->buffer_index,
1367 server->buffer, server->data);
1368 /* Record the fact that we've searched the data already in
1369 the buffer for a CRLF, so that when we search below, we
1370 don't have to search the same data twice. There's a "-
1371 1" here to account for the fact that the last character
1372 of the data we have may be the CR of a CRLF pair, of
1373 which we haven't read the second half yet, so we may have
1374 to search it again when we read more data. */
1375 search_offset = server->data - 1;
1376 server->buffer_index = 0;
1379 else
1381 server->buffer_index = 0;
1384 while (1)
1386 /* There's a "- 1" here to leave room for the null that we put
1387 at the end of the read data below. We put the null there so
1388 that find_crlf knows where to stop when we call it. */
1389 if (server->data == server->buffer_size - 1)
1391 server->buffer_size += GETLINE_INCR;
1392 server->buffer = (char *)realloc (server->buffer, server->buffer_size);
1393 if (! server->buffer)
1395 strcpy (pop_error, "Out of memory in pop_getline");
1396 pop_trash (server);
1397 return (-1);
1400 ret = RECV (server->file, server->buffer + server->data,
1401 server->buffer_size - server->data - 1, 0);
1402 if (ret < 0)
1404 strcpy (pop_error, GETLINE_ERROR);
1405 strncat (pop_error, strerror (errno),
1406 ERROR_MAX - sizeof (GETLINE_ERROR));
1407 pop_trash (server);
1408 return (-1);
1410 else if (ret == 0)
1412 strcpy (pop_error, "Unexpected EOF from server in pop_getline");
1413 pop_trash (server);
1414 return (-1);
1416 else
1418 char *cp;
1419 server->data += ret;
1420 server->buffer[server->data] = '\0';
1422 cp = find_crlf (server->buffer + search_offset,
1423 server->data - search_offset);
1424 if (cp)
1426 int data_used = (cp + 2) - server->buffer;
1427 *cp = '\0';
1428 server->data -= data_used;
1429 server->buffer_index = data_used;
1431 if (pop_debug)
1432 fprintf (stderr, "<<< %s\n", server->buffer);
1433 *line = server->buffer;
1434 return (data_used - 2);
1436 /* As above, the "- 1" here is to account for the fact that
1437 we may have read a CR without its accompanying LF. */
1438 search_offset += ret - 1;
1442 /* NOTREACHED */
1446 * Function: sendline
1448 * Purpose: Sends a line of text to the POP server. The line of text
1449 * passed into this function should NOT have the carriage return
1450 * and linefeed on the end of it. Periods at beginnings of lines
1451 * will NOT be treated specially by this function.
1453 * Arguments:
1454 * server The server to which to send the text.
1455 * line The line of text to send.
1457 * Return value: Upon successful completion, a value of 0 will be
1458 * returned. Otherwise, a non-zero value will be returned, and
1459 * an error will be copied into pop_error.
1461 * Side effects: Closes the connection on error.
1463 static int
1464 sendline (server, line)
1465 popserver server;
1466 char *line;
1468 #define SENDLINE_ERROR "Error writing to POP server: "
1469 int ret;
1470 char *buf;
1472 /* Combine the string and the CR-LF into one buffer. Otherwise, two
1473 reasonable network stack optimizations, Nagle's algorithm and
1474 delayed acks, combine to delay us a fraction of a second on every
1475 message we send. (Movemail writes line without \r\n, client
1476 kernel sends packet, server kernel delays the ack to see if it
1477 can combine it with data, movemail writes \r\n, client kernel
1478 waits because it has unacked data already in its outgoing queue,
1479 client kernel eventually times out and sends.)
1481 This can be something like 0.2s per command, which can add up
1482 over a few dozen messages, and is a big chunk of the time we
1483 spend fetching mail from a server close by. */
1484 buf = alloca (strlen (line) + 3);
1485 strcpy (buf, line);
1486 strcat (buf, "\r\n");
1487 ret = fullwrite (server->file, buf, strlen (buf));
1489 if (ret < 0)
1491 pop_trash (server);
1492 strcpy (pop_error, SENDLINE_ERROR);
1493 strncat (pop_error, strerror (errno),
1494 ERROR_MAX - sizeof (SENDLINE_ERROR));
1495 return (ret);
1498 if (pop_debug)
1499 fprintf (stderr, ">>> %s\n", line);
1501 return (0);
1505 * Procedure: fullwrite
1507 * Purpose: Just like write, but keeps trying until the entire string
1508 * has been written.
1510 * Return value: Same as write. Pop_error is not set.
1512 static int
1513 fullwrite (fd, buf, nbytes)
1514 int fd;
1515 char *buf;
1516 int nbytes;
1518 char *cp;
1519 int ret = 0;
1521 cp = buf;
1522 while (nbytes && ((ret = SEND (fd, cp, nbytes, 0)) > 0))
1524 cp += ret;
1525 nbytes -= ret;
1528 return (ret);
1532 * Procedure getok
1534 * Purpose: Reads a line from the server. If the return indicator is
1535 * positive, return with a zero exit status. If not, return with
1536 * a negative exit status.
1538 * Arguments:
1539 * server The server to read from.
1541 * Returns: 0 for success, else for failure and puts error in pop_error.
1543 * Side effects: On failure, may make the connection unusable.
1545 static int
1546 getok (server)
1547 popserver server;
1549 char *fromline;
1551 if (pop_getline (server, &fromline) < 0)
1553 return (-1);
1556 if (! strncmp (fromline, "+OK", 3))
1557 return (0);
1558 else if (! strncmp (fromline, "-ERR", 4))
1560 strncpy (pop_error, fromline, ERROR_MAX);
1561 pop_error[ERROR_MAX-1] = '\0';
1562 return (-1);
1564 else
1566 strcpy (pop_error,
1567 "Unexpected response from server; expecting +OK or -ERR");
1568 pop_trash (server);
1569 return (-1);
1573 #if 0
1575 * Function: gettermination
1577 * Purpose: Gets the next line and verifies that it is a termination
1578 * line (nothing but a dot).
1580 * Return value: 0 on success, non-zero with pop_error set on error.
1582 * Side effects: Closes the connection on error.
1584 static int
1585 gettermination (server)
1586 popserver server;
1588 char *fromserver;
1590 if (pop_getline (server, &fromserver) < 0)
1591 return (-1);
1593 if (strcmp (fromserver, "."))
1595 strcpy (pop_error,
1596 "Unexpected response from server in gettermination");
1597 pop_trash (server);
1598 return (-1);
1601 return (0);
1603 #endif
1606 * Function pop_close
1608 * Purpose: Close a pop connection, sending a "RSET" command to try to
1609 * preserve any changes that were made and a "QUIT" command to
1610 * try to get the server to quit, but ignoring any responses that
1611 * are received.
1613 * Side effects: The server is unusable after this function returns.
1614 * Changes made to the maildrop since the session was started (or
1615 * since the last pop_reset) may be lost.
1617 void
1618 pop_close (server)
1619 popserver server;
1621 pop_trash (server);
1622 free ((char *) server);
1624 return;
1628 * Function: pop_trash
1630 * Purpose: Like pop_close or pop_quit, but doesn't deallocate the
1631 * memory associated with the server. It is valid to call
1632 * pop_close or pop_quit after this function has been called.
1634 static void
1635 pop_trash (server)
1636 popserver server;
1638 if (server->file >= 0)
1640 /* avoid recursion; sendline can call pop_trash */
1641 if (server->trash_started)
1642 return;
1643 server->trash_started = 1;
1645 sendline (server, "RSET");
1646 sendline (server, "QUIT");
1648 CLOSESOCKET (server->file);
1649 server->file = -1;
1650 if (server->buffer)
1652 free (server->buffer);
1653 server->buffer = 0;
1657 #ifdef WINDOWSNT
1658 if (have_winsock)
1659 WSACleanup ();
1660 #endif
1663 /* Return a pointer to the first CRLF in IN_STRING, which can contain
1664 embedded nulls and has LEN characters in it not including the final
1665 null, or 0 if it does not contain one. */
1667 static char *
1668 find_crlf (in_string, len)
1669 char *in_string;
1670 int len;
1672 while (len--)
1674 if (*in_string == '\r')
1676 if (*++in_string == '\n')
1677 return (in_string - 1);
1679 else
1680 in_string++;
1682 return (0);
1685 #endif /* MAIL_USE_POP */
1687 /* arch-tag: ceb37041-b7ad-49a8-a63d-286618b8367d
1688 (do not change this comment) */