* viper*el: replaced old-style backquotes.
[emacs.git] / lib-src / pop.c
blobc6b86e5a2dceee620ec90d7205de69e72d2214ce
1 /* pop.c: client routines for talking to a POP3-protocol post-office server
2 Copyright (c) 1991, 1993, 1996, 1997, 1999 Free Software Foundation, Inc.
3 Written by Jonathan Kamens, jik@security.ov.com.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifdef HAVE_CONFIG_H
23 #define NO_SHORTNAMES /* Tell config not to load remap.h */
24 #include <../src/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_DES_H
80 # include <des.h>
81 # else
82 # ifdef HAVE_KERBEROSIV_DES_H
83 # include <kerberosIV/des.h>
84 # else
85 # ifdef HAVE_KERBEROS_DES_H
86 # include <kerberos/des.h>
87 # endif
88 # endif
89 # endif
90 # ifdef HAVE_KRB_H
91 # include <krb.h>
92 # else
93 # ifdef HAVE_KERBEROSIV_KRB_H
94 # include <kerberosIV/krb.h>
95 # else
96 # ifdef HAVE_KERBEROS_KRB_H
97 # include <kerberos/krb.h>
98 # endif
99 # endif
100 # endif
101 # ifdef HAVE_COM_ERR_H
102 # include <com_err.h>
103 # endif
104 #endif /* KERBEROS */
106 #ifdef KERBEROS
107 #ifndef KERBEROS5
108 extern int krb_sendauth (/* long, int, KTEXT, char *, char *, char *,
109 u_long, MSG_DAT *, CREDENTIALS *, Key_schedule,
110 struct sockaddr_in *, struct sockaddr_in *,
111 char * */);
112 extern char *krb_realmofhost (/* char * */);
113 #endif /* ! KERBEROS5 */
114 #endif /* KERBEROS */
116 #ifndef WINDOWSNT
117 #if !defined(HAVE_H_ERRNO) || !defined(HAVE_CONFIG_H)
118 extern int h_errno;
119 #endif
120 #endif
122 #ifndef _P
123 # ifdef __STDC__
124 # define _P(a) a
125 # else
126 # define _P(a) ()
127 # endif /* __STDC__ */
128 #endif /* ! __P */
130 static int socket_connection _P((char *, int));
131 static int pop_getline _P((popserver, char **));
132 static int sendline _P((popserver, char *));
133 static int fullwrite _P((int, char *, int));
134 static int getok _P((popserver));
135 #if 0
136 static int gettermination _P((popserver));
137 #endif
138 static void pop_trash _P((popserver));
139 static char *find_crlf _P((char *, int));
141 #define ERROR_MAX 80 /* a pretty arbitrary size */
142 #define POP_PORT 110
143 #define KPOP_PORT 1109
144 #define POP_SERVICE "pop3" /* we don't want the POP2 port! */
145 #ifdef KERBEROS
146 #define KPOP_SERVICE "kpop"
147 #endif
149 char pop_error[ERROR_MAX];
150 int pop_debug = 0;
152 #ifndef min
153 #define min(a,b) (((a) < (b)) ? (a) : (b))
154 #endif
157 * Function: pop_open (char *host, char *username, char *password,
158 * int flags)
160 * Purpose: Establishes a connection with a post-office server, and
161 * completes the authorization portion of the session.
163 * Arguments:
164 * host The server host with which the connection should be
165 * established. Optional. If omitted, internal
166 * heuristics will be used to determine the server host,
167 * if possible.
168 * username
169 * The username of the mail-drop to access. Optional.
170 * If omitted, internal heuristics will be used to
171 * determine the username, if possible.
172 * password
173 * The password to use for authorization. If omitted,
174 * internal heuristics will be used to determine the
175 * password, if possible.
176 * flags A bit mask containing flags controlling certain
177 * functions of the routine. Valid flags are defined in
178 * the file pop.h
180 * Return value: Upon successful establishment of a connection, a
181 * non-null popserver will be returned. Otherwise, null will be
182 * returned, and the string variable pop_error will contain an
183 * explanation of the error.
185 popserver
186 pop_open (host, username, password, flags)
187 char *host;
188 char *username;
189 char *password;
190 int flags;
192 int sock;
193 popserver server;
195 /* Determine the user name */
196 if (! username)
198 username = getenv ("USER");
199 if (! (username && *username))
201 username = getlogin ();
202 if (! (username && *username))
204 struct passwd *passwd;
205 passwd = getpwuid (getuid ());
206 if (passwd && passwd->pw_name && *passwd->pw_name)
208 username = passwd->pw_name;
210 else
212 strcpy (pop_error, "Could not determine username");
213 return (0);
220 * Determine the mail host.
223 if (! host)
225 host = getenv ("MAILHOST");
228 #ifdef HESIOD
229 if ((! host) && (! (flags & POP_NO_HESIOD)))
231 struct hes_postoffice *office;
232 office = hes_getmailhost (username);
233 if (office && office->po_type && (! strcmp (office->po_type, "POP"))
234 && office->po_name && *office->po_name && office->po_host
235 && *office->po_host)
237 host = office->po_host;
238 username = office->po_name;
241 #endif
243 #ifdef MAILHOST
244 if (! host)
246 host = MAILHOST;
248 #endif
250 if (! host)
252 strcpy (pop_error, "Could not determine POP server");
253 return (0);
256 /* Determine the password */
257 #ifdef KERBEROS
258 #define DONT_NEED_PASSWORD (! (flags & POP_NO_KERBEROS))
259 #else
260 #define DONT_NEED_PASSWORD 0
261 #endif
263 if ((! password) && (! DONT_NEED_PASSWORD))
265 if (! (flags & POP_NO_GETPASS))
267 password = getpass ("Enter POP password:");
269 if (! password)
271 strcpy (pop_error, "Could not determine POP password");
272 return (0);
275 if (password)
276 flags |= POP_NO_KERBEROS;
277 else
278 password = username;
280 sock = socket_connection (host, flags);
281 if (sock == -1)
282 return (0);
284 server = (popserver) malloc (sizeof (struct _popserver));
285 if (! server)
287 strcpy (pop_error, "Out of memory in pop_open");
288 return (0);
290 server->buffer = (char *) malloc (GETLINE_MIN);
291 if (! server->buffer)
293 strcpy (pop_error, "Out of memory in pop_open");
294 free ((char *) server);
295 return (0);
298 server->file = sock;
299 server->data = 0;
300 server->buffer_index = 0;
301 server->buffer_size = GETLINE_MIN;
302 server->in_multi = 0;
303 server->trash_started = 0;
305 if (getok (server))
306 return (0);
309 * I really shouldn't use the pop_error variable like this, but....
311 if (strlen (username) > ERROR_MAX - 6)
313 pop_close (server);
314 strcpy (pop_error,
315 "Username too long; recompile pop.c with larger ERROR_MAX");
316 return (0);
318 sprintf (pop_error, "USER %s", username);
320 if (sendline (server, pop_error) || getok (server))
322 return (0);
325 if (strlen (password) > ERROR_MAX - 6)
327 pop_close (server);
328 strcpy (pop_error,
329 "Password too long; recompile pop.c with larger ERROR_MAX");
330 return (0);
332 sprintf (pop_error, "PASS %s", password);
334 if (sendline (server, pop_error) || getok (server))
336 return (0);
339 return (server);
343 * Function: pop_stat
345 * Purpose: Issue the STAT command to the server and return (in the
346 * value parameters) the number of messages in the maildrop and
347 * the total size of the maildrop.
349 * Return value: 0 on success, or non-zero with an error in pop_error
350 * in failure.
352 * Side effects: On failure, may make further operations on the
353 * connection impossible.
356 pop_stat (server, count, size)
357 popserver server;
358 int *count;
359 int *size;
361 char *fromserver;
363 if (server->in_multi)
365 strcpy (pop_error, "In multi-line query in pop_stat");
366 return (-1);
369 if (sendline (server, "STAT") || (pop_getline (server, &fromserver) < 0))
370 return (-1);
372 if (strncmp (fromserver, "+OK ", 4))
374 if (0 == strncmp (fromserver, "-ERR", 4))
376 strncpy (pop_error, fromserver, ERROR_MAX);
378 else
380 strcpy (pop_error,
381 "Unexpected response from POP server in pop_stat");
382 pop_trash (server);
384 return (-1);
387 *count = atoi (&fromserver[4]);
389 fromserver = index (&fromserver[4], ' ');
390 if (! fromserver)
392 strcpy (pop_error,
393 "Badly formatted response from server in pop_stat");
394 pop_trash (server);
395 return (-1);
398 *size = atoi (fromserver + 1);
400 return (0);
404 * Function: pop_list
406 * Purpose: Performs the POP "list" command and returns (in value
407 * parameters) two malloc'd zero-terminated arrays -- one of
408 * message IDs, and a parallel one of sizes.
410 * Arguments:
411 * server The pop connection to talk to.
412 * message The number of the one message about which to get
413 * information, or 0 to get information about all
414 * messages.
416 * Return value: 0 on success, non-zero with error in pop_error on
417 * failure.
419 * Side effects: On failure, may make further operations on the
420 * connection impossible.
423 pop_list (server, message, IDs, sizes)
424 popserver server;
425 int message;
426 int **IDs;
427 int **sizes;
429 int how_many, i;
430 char *fromserver;
432 if (server->in_multi)
434 strcpy (pop_error, "In multi-line query in pop_list");
435 return (-1);
438 if (message)
439 how_many = 1;
440 else
442 int count, size;
443 if (pop_stat (server, &count, &size))
444 return (-1);
445 how_many = count;
448 *IDs = (int *) malloc ((how_many + 1) * sizeof (int));
449 *sizes = (int *) malloc ((how_many + 1) * sizeof (int));
450 if (! (*IDs && *sizes))
452 strcpy (pop_error, "Out of memory in pop_list");
453 return (-1);
456 if (message)
458 sprintf (pop_error, "LIST %d", message);
459 if (sendline (server, pop_error))
461 free ((char *) *IDs);
462 free ((char *) *sizes);
463 return (-1);
465 if (pop_getline (server, &fromserver) < 0)
467 free ((char *) *IDs);
468 free ((char *) *sizes);
469 return (-1);
471 if (strncmp (fromserver, "+OK ", 4))
473 if (! strncmp (fromserver, "-ERR", 4))
474 strncpy (pop_error, fromserver, ERROR_MAX);
475 else
477 strcpy (pop_error,
478 "Unexpected response from server in pop_list");
479 pop_trash (server);
481 free ((char *) *IDs);
482 free ((char *) *sizes);
483 return (-1);
485 (*IDs)[0] = atoi (&fromserver[4]);
486 fromserver = index (&fromserver[4], ' ');
487 if (! fromserver)
489 strcpy (pop_error,
490 "Badly formatted response from server in pop_list");
491 pop_trash (server);
492 free ((char *) *IDs);
493 free ((char *) *sizes);
494 return (-1);
496 (*sizes)[0] = atoi (fromserver);
497 (*IDs)[1] = (*sizes)[1] = 0;
498 return (0);
500 else
502 if (pop_multi_first (server, "LIST", &fromserver))
504 free ((char *) *IDs);
505 free ((char *) *sizes);
506 return (-1);
508 for (i = 0; i < how_many; i++)
510 if (pop_multi_next (server, &fromserver) <= 0)
512 free ((char *) *IDs);
513 free ((char *) *sizes);
514 return (-1);
516 (*IDs)[i] = atoi (fromserver);
517 fromserver = index (fromserver, ' ');
518 if (! fromserver)
520 strcpy (pop_error,
521 "Badly formatted response from server in pop_list");
522 free ((char *) *IDs);
523 free ((char *) *sizes);
524 pop_trash (server);
525 return (-1);
527 (*sizes)[i] = atoi (fromserver);
529 if (pop_multi_next (server, &fromserver) < 0)
531 free ((char *) *IDs);
532 free ((char *) *sizes);
533 return (-1);
535 else if (fromserver)
537 strcpy (pop_error,
538 "Too many response lines from server in pop_list");
539 free ((char *) *IDs);
540 free ((char *) *sizes);
541 return (-1);
543 (*IDs)[i] = (*sizes)[i] = 0;
544 return (0);
549 * Function: pop_retrieve
551 * Purpose: Retrieve a specified message from the maildrop.
553 * Arguments:
554 * server The server to retrieve from.
555 * message The message number to retrieve.
556 * markfrom
557 * If true, then mark the string "From " at the beginning
558 * of lines with '>'.
559 * msg_buf Output parameter to which a buffer containing the
560 * message is assigned.
562 * Return value: The number of bytes in msg_buf, which may contain
563 * embedded nulls, not including its final null, or -1 on error
564 * with pop_error set.
566 * Side effects: May kill connection on error.
569 pop_retrieve (server, message, markfrom, msg_buf)
570 popserver server;
571 int message;
572 int markfrom;
573 char **msg_buf;
575 int *IDs, *sizes, bufsize, fromcount = 0, cp = 0;
576 char *ptr, *fromserver;
577 int ret;
579 if (server->in_multi)
581 strcpy (pop_error, "In multi-line query in pop_retrieve");
582 return (-1);
585 if (pop_list (server, message, &IDs, &sizes))
586 return (-1);
588 if (pop_retrieve_first (server, message, &fromserver))
590 return (-1);
594 * The "5" below is an arbitrary constant -- I assume that if
595 * there are "From" lines in the text to be marked, there
596 * probably won't be more than 5 of them. If there are, I
597 * allocate more space for them below.
599 bufsize = sizes[0] + (markfrom ? 5 : 0);
600 ptr = (char *)malloc (bufsize);
601 free ((char *) IDs);
602 free ((char *) sizes);
604 if (! ptr)
606 strcpy (pop_error, "Out of memory in pop_retrieve");
607 pop_retrieve_flush (server);
608 return (-1);
611 while ((ret = pop_retrieve_next (server, &fromserver)) >= 0)
613 if (! fromserver)
615 ptr[cp] = '\0';
616 *msg_buf = ptr;
617 return (cp);
619 if (markfrom && fromserver[0] == 'F' && fromserver[1] == 'r' &&
620 fromserver[2] == 'o' && fromserver[3] == 'm' &&
621 fromserver[4] == ' ')
623 if (++fromcount == 5)
625 bufsize += 5;
626 ptr = (char *)realloc (ptr, bufsize);
627 if (! ptr)
629 strcpy (pop_error, "Out of memory in pop_retrieve");
630 pop_retrieve_flush (server);
631 return (-1);
633 fromcount = 0;
635 ptr[cp++] = '>';
637 bcopy (fromserver, &ptr[cp], ret);
638 cp += ret;
639 ptr[cp++] = '\n';
642 free (ptr);
643 return (-1);
647 pop_retrieve_first (server, message, response)
648 popserver server;
649 int message;
650 char **response;
652 sprintf (pop_error, "RETR %d", message);
653 return (pop_multi_first (server, pop_error, response));
657 Returns a negative number on error, 0 to indicate that the data has
658 all been read (i.e., the server has returned a "." termination
659 line), or a positive number indicating the number of bytes in the
660 returned buffer (which is null-terminated and may contain embedded
661 nulls, but the returned bytecount doesn't include the final null).
665 pop_retrieve_next (server, line)
666 popserver server;
667 char **line;
669 return (pop_multi_next (server, line));
673 pop_retrieve_flush (server)
674 popserver server;
676 return (pop_multi_flush (server));
680 pop_top_first (server, message, lines, response)
681 popserver server;
682 int message, lines;
683 char **response;
685 sprintf (pop_error, "TOP %d %d", message, lines);
686 return (pop_multi_first (server, pop_error, response));
690 Returns a negative number on error, 0 to indicate that the data has
691 all been read (i.e., the server has returned a "." termination
692 line), or a positive number indicating the number of bytes in the
693 returned buffer (which is null-terminated and may contain embedded
694 nulls, but the returned bytecount doesn't include the final null).
698 pop_top_next (server, line)
699 popserver server;
700 char **line;
702 return (pop_multi_next (server, line));
706 pop_top_flush (server)
707 popserver server;
709 return (pop_multi_flush (server));
713 pop_multi_first (server, command, response)
714 popserver server;
715 char *command;
716 char **response;
718 if (server->in_multi)
720 strcpy (pop_error,
721 "Already in multi-line query in pop_multi_first");
722 return (-1);
725 if (sendline (server, command) || (pop_getline (server, response) < 0))
727 return (-1);
730 if (0 == strncmp (*response, "-ERR", 4))
732 strncpy (pop_error, *response, ERROR_MAX);
733 return (-1);
735 else if (0 == strncmp (*response, "+OK", 3))
737 for (*response += 3; **response == ' '; (*response)++) /* empty */;
738 server->in_multi = 1;
739 return (0);
741 else
743 strcpy (pop_error,
744 "Unexpected response from server in pop_multi_first");
745 return (-1);
750 Read the next line of data from SERVER and place a pointer to it
751 into LINE. Return -1 on error, 0 if there are no more lines to read
752 (i.e., the server has returned a line containing only "."), or a
753 positive number indicating the number of bytes in the LINE buffer
754 (not including the final null). The data in that buffer may contain
755 embedded nulls, but does not contain the final CRLF. When returning
756 0, LINE is set to null. */
759 pop_multi_next (server, line)
760 popserver server;
761 char **line;
763 char *fromserver;
764 int ret;
766 if (! server->in_multi)
768 strcpy (pop_error, "Not in multi-line query in pop_multi_next");
769 return (-1);
772 if ((ret = pop_getline (server, &fromserver)) < 0)
774 return (-1);
777 if (fromserver[0] == '.')
779 if (! fromserver[1])
781 *line = 0;
782 server->in_multi = 0;
783 return (0);
785 else
787 *line = fromserver + 1;
788 return (ret - 1);
791 else
793 *line = fromserver;
794 return (ret);
799 pop_multi_flush (server)
800 popserver server;
802 char *line;
803 int ret;
805 if (! server->in_multi)
807 return (0);
810 while ((ret = pop_multi_next (server, &line)))
812 if (ret < 0)
813 return (-1);
816 return (0);
819 /* Function: pop_delete
821 * Purpose: Delete a specified message.
823 * Arguments:
824 * server Server from which to delete the message.
825 * message Message to delete.
827 * Return value: 0 on success, non-zero with error in pop_error
828 * otherwise.
831 pop_delete (server, message)
832 popserver server;
833 int message;
835 if (server->in_multi)
837 strcpy (pop_error, "In multi-line query in pop_delete");
838 return (-1);
841 sprintf (pop_error, "DELE %d", message);
843 if (sendline (server, pop_error) || getok (server))
844 return (-1);
846 return (0);
850 * Function: pop_noop
852 * Purpose: Send a noop command to the server.
854 * Argument:
855 * server The server to send to.
857 * Return value: 0 on success, non-zero with error in pop_error
858 * otherwise.
860 * Side effects: Closes connection on error.
863 pop_noop (server)
864 popserver server;
866 if (server->in_multi)
868 strcpy (pop_error, "In multi-line query in pop_noop");
869 return (-1);
872 if (sendline (server, "NOOP") || getok (server))
873 return (-1);
875 return (0);
879 * Function: pop_last
881 * Purpose: Find out the highest seen message from the server.
883 * Arguments:
884 * server The server.
886 * Return value: If successful, the highest seen message, which is
887 * greater than or equal to 0. Otherwise, a negative number with
888 * the error explained in pop_error.
890 * Side effects: Closes the connection on error.
893 pop_last (server)
894 popserver server;
896 char *fromserver;
898 if (server->in_multi)
900 strcpy (pop_error, "In multi-line query in pop_last");
901 return (-1);
904 if (sendline (server, "LAST"))
905 return (-1);
907 if (pop_getline (server, &fromserver) < 0)
908 return (-1);
910 if (! strncmp (fromserver, "-ERR", 4))
912 strncpy (pop_error, fromserver, ERROR_MAX);
913 return (-1);
915 else if (strncmp (fromserver, "+OK ", 4))
917 strcpy (pop_error, "Unexpected response from server in pop_last");
918 pop_trash (server);
919 return (-1);
921 else
923 return (atoi (&fromserver[4]));
928 * Function: pop_reset
930 * Purpose: Reset the server to its initial connect state
932 * Arguments:
933 * server The server.
935 * Return value: 0 for success, non-0 with error in pop_error
936 * otherwise.
938 * Side effects: Closes the connection on error.
941 pop_reset (server)
942 popserver server;
944 if (pop_retrieve_flush (server))
946 return (-1);
949 if (sendline (server, "RSET") || getok (server))
950 return (-1);
952 return (0);
956 * Function: pop_quit
958 * Purpose: Quit the connection to the server,
960 * Arguments:
961 * server The server to quit.
963 * Return value: 0 for success, non-zero otherwise with error in
964 * pop_error.
966 * Side Effects: The popserver passed in is unusable after this
967 * function is called, even if an error occurs.
970 pop_quit (server)
971 popserver server;
973 int ret = 0;
975 if (server->file >= 0)
977 if (pop_retrieve_flush (server))
979 ret = -1;
982 if (sendline (server, "QUIT") || getok (server))
984 ret = -1;
987 close (server->file);
990 if (server->buffer)
991 free (server->buffer);
992 free ((char *) server);
994 return (ret);
997 #ifdef WINDOWSNT
998 static int have_winsock = 0;
999 #endif
1002 * Function: socket_connection
1004 * Purpose: Opens the network connection with the mail host, without
1005 * doing any sort of I/O with it or anything.
1007 * Arguments:
1008 * host The host to which to connect.
1009 * flags Option flags.
1011 * Return value: A file descriptor indicating the connection, or -1
1012 * indicating failure, in which case an error has been copied
1013 * into pop_error.
1015 static int
1016 socket_connection (host, flags)
1017 char *host;
1018 int flags;
1020 struct hostent *hostent;
1021 struct servent *servent;
1022 struct sockaddr_in addr;
1023 char found_port = 0;
1024 char *service;
1025 int sock;
1026 #ifdef KERBEROS
1027 #ifdef KERBEROS5
1028 krb5_error_code rem;
1029 krb5_context kcontext = 0;
1030 krb5_auth_context auth_context = 0;
1031 krb5_ccache ccdef;
1032 krb5_principal client, server;
1033 krb5_error *err_ret;
1034 register char *cp;
1035 #else
1036 KTEXT ticket;
1037 MSG_DAT msg_data;
1038 CREDENTIALS cred;
1039 Key_schedule schedule;
1040 int rem;
1041 char *realhost;
1042 #endif /* KERBEROS5 */
1043 #endif /* KERBEROS */
1045 int try_count = 0;
1047 #ifdef WINDOWSNT
1049 WSADATA winsockData;
1050 if (WSAStartup (0x101, &winsockData) == 0)
1051 have_winsock = 1;
1053 #endif
1057 hostent = gethostbyname (host);
1058 try_count++;
1059 if ((! hostent) && ((h_errno != TRY_AGAIN) || (try_count == 5)))
1061 strcpy (pop_error, "Could not determine POP server's address");
1062 return (-1);
1064 } while (! hostent);
1066 bzero ((char *) &addr, sizeof (addr));
1067 addr.sin_family = AF_INET;
1069 #ifdef KERBEROS
1070 service = (flags & POP_NO_KERBEROS) ? POP_SERVICE : KPOP_SERVICE;
1071 #else
1072 service = POP_SERVICE;
1073 #endif
1075 #ifdef HESIOD
1076 if (! (flags & POP_NO_HESIOD))
1078 servent = hes_getservbyname (service, "tcp");
1079 if (servent)
1081 addr.sin_port = servent->s_port;
1082 found_port = 1;
1085 #endif
1086 if (! found_port)
1088 servent = getservbyname (service, "tcp");
1089 if (servent)
1091 addr.sin_port = servent->s_port;
1093 else
1095 #ifdef KERBEROS
1096 addr.sin_port = htons ((flags & POP_NO_KERBEROS) ?
1097 POP_PORT : KPOP_PORT);
1098 #else
1099 addr.sin_port = htons (POP_PORT);
1100 #endif
1104 #define POP_SOCKET_ERROR "Could not create socket for POP connection: "
1106 sock = socket (PF_INET, SOCK_STREAM, 0);
1107 if (sock < 0)
1109 strcpy (pop_error, POP_SOCKET_ERROR);
1110 strncat (pop_error, strerror (errno),
1111 ERROR_MAX - sizeof (POP_SOCKET_ERROR));
1112 return (-1);
1116 while (*hostent->h_addr_list)
1118 bcopy (*hostent->h_addr_list, (char *) &addr.sin_addr,
1119 hostent->h_length);
1120 if (! connect (sock, (struct sockaddr *) &addr, sizeof (addr)))
1121 break;
1122 hostent->h_addr_list++;
1125 #define CONNECT_ERROR "Could not connect to POP server: "
1127 if (! *hostent->h_addr_list)
1129 CLOSESOCKET (sock);
1130 strcpy (pop_error, CONNECT_ERROR);
1131 strncat (pop_error, strerror (errno),
1132 ERROR_MAX - sizeof (CONNECT_ERROR));
1133 return (-1);
1137 #ifdef KERBEROS
1138 #define KRB_ERROR "Kerberos error connecting to POP server: "
1139 if (! (flags & POP_NO_KERBEROS))
1141 #ifdef KERBEROS5
1142 if ((rem = krb5_init_context (&kcontext)))
1144 krb5error:
1145 if (auth_context)
1146 krb5_auth_con_free (kcontext, auth_context);
1147 if (kcontext)
1148 krb5_free_context (kcontext);
1149 strcpy (pop_error, KRB_ERROR);
1150 strncat (pop_error, error_message (rem),
1151 ERROR_MAX - sizeof(KRB_ERROR));
1152 CLOSESOCKET (sock);
1153 return (-1);
1156 if ((rem = krb5_auth_con_init (kcontext, &auth_context)))
1157 goto krb5error;
1159 if (rem = krb5_cc_default (kcontext, &ccdef))
1160 goto krb5error;
1162 if (rem = krb5_cc_get_principal (kcontext, ccdef, &client))
1163 goto krb5error;
1165 for (cp = hostent->h_name; *cp; cp++)
1167 if (isupper (*cp))
1169 *cp = tolower (*cp);
1173 if (rem = krb5_sname_to_principal (kcontext, hostent->h_name,
1174 POP_SERVICE, FALSE, &server))
1175 goto krb5error;
1177 rem = krb5_sendauth (kcontext, &auth_context,
1178 (krb5_pointer) &sock, "KPOPV1.0", client, server,
1179 AP_OPTS_MUTUAL_REQUIRED,
1180 0, /* no checksum */
1181 0, /* no creds, use ccache instead */
1182 ccdef,
1183 &err_ret,
1184 0, /* don't need subsession key */
1185 0); /* don't need reply */
1186 krb5_free_principal (kcontext, server);
1187 if (rem)
1189 if (err_ret && err_ret->text.length)
1191 strcpy (pop_error, KRB_ERROR);
1192 strncat (pop_error, error_message (rem),
1193 ERROR_MAX - sizeof (KRB_ERROR));
1194 strncat (pop_error, " [server says '",
1195 ERROR_MAX - strlen (pop_error) - 1);
1196 strncat (pop_error, err_ret->text.data,
1197 min (ERROR_MAX - strlen (pop_error) - 1,
1198 err_ret->text.length));
1199 strncat (pop_error, "']",
1200 ERROR_MAX - strlen (pop_error) - 1);
1202 else
1204 strcpy (pop_error, KRB_ERROR);
1205 strncat (pop_error, error_message (rem),
1206 ERROR_MAX - sizeof (KRB_ERROR));
1208 if (err_ret)
1209 krb5_free_error (kcontext, err_ret);
1210 krb5_auth_con_free (kcontext, auth_context);
1211 krb5_free_context (kcontext);
1213 CLOSESOCKET (sock);
1214 return (-1);
1216 #else /* ! KERBEROS5 */
1217 ticket = (KTEXT) malloc (sizeof (KTEXT_ST));
1218 realhost = strdup (hostent->h_name);
1219 rem = krb_sendauth (0L, sock, ticket, "pop", realhost,
1220 (char *) krb_realmofhost (realhost),
1221 (unsigned long) 0, &msg_data, &cred, schedule,
1222 (struct sockaddr_in *) 0,
1223 (struct sockaddr_in *) 0,
1224 "KPOPV0.1");
1225 free ((char *) ticket);
1226 free (realhost);
1227 if (rem != KSUCCESS)
1229 strcpy (pop_error, KRB_ERROR);
1230 strncat (pop_error, krb_err_txt[rem],
1231 ERROR_MAX - sizeof (KRB_ERROR));
1232 CLOSESOCKET (sock);
1233 return (-1);
1235 #endif /* KERBEROS5 */
1237 #endif /* KERBEROS */
1239 return (sock);
1240 } /* socket_connection */
1243 * Function: pop_getline
1245 * Purpose: Get a line of text from the connection and return a
1246 * pointer to it. The carriage return and linefeed at the end of
1247 * the line are stripped, but periods at the beginnings of lines
1248 * are NOT dealt with in any special way.
1250 * Arguments:
1251 * server The server from which to get the line of text.
1253 * Returns: The number of characters in the line, which is returned in
1254 * LINE, not including the final null. A return value of 0
1255 * indicates a blank line. A negative return value indicates an
1256 * error (in which case the contents of LINE are undefined. In
1257 * case of error, an error message is copied into pop_error.
1259 * Notes: The line returned is overwritten with each call to pop_getline.
1261 * Side effects: Closes the connection on error.
1263 * THE RETURNED LINE MAY CONTAIN EMBEDDED NULLS!
1265 static int
1266 pop_getline (server, line)
1267 popserver server;
1268 char **line;
1270 #define GETLINE_ERROR "Error reading from server: "
1272 int ret;
1273 int search_offset = 0;
1275 if (server->data)
1277 char *cp = find_crlf (server->buffer + server->buffer_index,
1278 server->data);
1279 if (cp)
1281 int found;
1282 int data_used;
1284 found = server->buffer_index;
1285 data_used = (cp + 2) - server->buffer - found;
1287 *cp = '\0'; /* terminate the string to be returned */
1288 server->data -= data_used;
1289 server->buffer_index += data_used;
1291 if (pop_debug)
1292 /* Embedded nulls will truncate this output prematurely,
1293 but that's OK because it's just for debugging anyway. */
1294 fprintf (stderr, "<<< %s\n", server->buffer + found);
1295 *line = server->buffer + found;
1296 return (data_used - 2);
1298 else
1300 bcopy (server->buffer + server->buffer_index,
1301 server->buffer, server->data);
1302 /* Record the fact that we've searched the data already in
1303 the buffer for a CRLF, so that when we search below, we
1304 don't have to search the same data twice. There's a "-
1305 1" here to account for the fact that the last character
1306 of the data we have may be the CR of a CRLF pair, of
1307 which we haven't read the second half yet, so we may have
1308 to search it again when we read more data. */
1309 search_offset = server->data - 1;
1310 server->buffer_index = 0;
1313 else
1315 server->buffer_index = 0;
1318 while (1)
1320 /* There's a "- 1" here to leave room for the null that we put
1321 at the end of the read data below. We put the null there so
1322 that find_crlf knows where to stop when we call it. */
1323 if (server->data == server->buffer_size - 1)
1325 server->buffer_size += GETLINE_INCR;
1326 server->buffer = (char *)realloc (server->buffer, server->buffer_size);
1327 if (! server->buffer)
1329 strcpy (pop_error, "Out of memory in pop_getline");
1330 pop_trash (server);
1331 return (-1);
1334 ret = RECV (server->file, server->buffer + server->data,
1335 server->buffer_size - server->data - 1, 0);
1336 if (ret < 0)
1338 strcpy (pop_error, GETLINE_ERROR);
1339 strncat (pop_error, strerror (errno),
1340 ERROR_MAX - sizeof (GETLINE_ERROR));
1341 pop_trash (server);
1342 return (-1);
1344 else if (ret == 0)
1346 strcpy (pop_error, "Unexpected EOF from server in pop_getline");
1347 pop_trash (server);
1348 return (-1);
1350 else
1352 char *cp;
1353 server->data += ret;
1354 server->buffer[server->data] = '\0';
1356 cp = find_crlf (server->buffer + search_offset,
1357 server->data - search_offset);
1358 if (cp)
1360 int data_used = (cp + 2) - server->buffer;
1361 *cp = '\0';
1362 server->data -= data_used;
1363 server->buffer_index = data_used;
1365 if (pop_debug)
1366 fprintf (stderr, "<<< %s\n", server->buffer);
1367 *line = server->buffer;
1368 return (data_used - 2);
1370 /* As above, the "- 1" here is to account for the fact that
1371 we may have read a CR without its accompanying LF. */
1372 search_offset += ret - 1;
1376 /* NOTREACHED */
1380 * Function: sendline
1382 * Purpose: Sends a line of text to the POP server. The line of text
1383 * passed into this function should NOT have the carriage return
1384 * and linefeed on the end of it. Periods at beginnings of lines
1385 * will NOT be treated specially by this function.
1387 * Arguments:
1388 * server The server to which to send the text.
1389 * line The line of text to send.
1391 * Return value: Upon successful completion, a value of 0 will be
1392 * returned. Otherwise, a non-zero value will be returned, and
1393 * an error will be copied into pop_error.
1395 * Side effects: Closes the connection on error.
1397 static int
1398 sendline (server, line)
1399 popserver server;
1400 char *line;
1402 #define SENDLINE_ERROR "Error writing to POP server: "
1403 int ret;
1405 ret = fullwrite (server->file, line, strlen (line));
1406 if (ret >= 0)
1407 { /* 0 indicates that a blank line was written */
1408 ret = fullwrite (server->file, "\r\n", 2);
1411 if (ret < 0)
1413 pop_trash (server);
1414 strcpy (pop_error, SENDLINE_ERROR);
1415 strncat (pop_error, strerror (errno),
1416 ERROR_MAX - sizeof (SENDLINE_ERROR));
1417 return (ret);
1420 if (pop_debug)
1421 fprintf (stderr, ">>> %s\n", line);
1423 return (0);
1427 * Procedure: fullwrite
1429 * Purpose: Just like write, but keeps trying until the entire string
1430 * has been written.
1432 * Return value: Same as write. Pop_error is not set.
1434 static int
1435 fullwrite (fd, buf, nbytes)
1436 int fd;
1437 char *buf;
1438 int nbytes;
1440 char *cp;
1441 int ret = 0;
1443 cp = buf;
1444 while (nbytes && ((ret = SEND (fd, cp, nbytes, 0)) > 0))
1446 cp += ret;
1447 nbytes -= ret;
1450 return (ret);
1454 * Procedure getok
1456 * Purpose: Reads a line from the server. If the return indicator is
1457 * positive, return with a zero exit status. If not, return with
1458 * a negative exit status.
1460 * Arguments:
1461 * server The server to read from.
1463 * Returns: 0 for success, else for failure and puts error in pop_error.
1465 * Side effects: On failure, may make the connection unusable.
1467 static int
1468 getok (server)
1469 popserver server;
1471 char *fromline;
1473 if (pop_getline (server, &fromline) < 0)
1475 return (-1);
1478 if (! strncmp (fromline, "+OK", 3))
1479 return (0);
1480 else if (! strncmp (fromline, "-ERR", 4))
1482 strncpy (pop_error, fromline, ERROR_MAX);
1483 pop_error[ERROR_MAX-1] = '\0';
1484 return (-1);
1486 else
1488 strcpy (pop_error,
1489 "Unexpected response from server; expecting +OK or -ERR");
1490 pop_trash (server);
1491 return (-1);
1495 #if 0
1497 * Function: gettermination
1499 * Purpose: Gets the next line and verifies that it is a termination
1500 * line (nothing but a dot).
1502 * Return value: 0 on success, non-zero with pop_error set on error.
1504 * Side effects: Closes the connection on error.
1506 static int
1507 gettermination (server)
1508 popserver server;
1510 char *fromserver;
1512 if (pop_getline (server, &fromserver) < 0)
1513 return (-1);
1515 if (strcmp (fromserver, "."))
1517 strcpy (pop_error,
1518 "Unexpected response from server in gettermination");
1519 pop_trash (server);
1520 return (-1);
1523 return (0);
1525 #endif
1528 * Function pop_close
1530 * Purpose: Close a pop connection, sending a "RSET" command to try to
1531 * preserve any changes that were made and a "QUIT" command to
1532 * try to get the server to quit, but ignoring any responses that
1533 * are received.
1535 * Side effects: The server is unusable after this function returns.
1536 * Changes made to the maildrop since the session was started (or
1537 * since the last pop_reset) may be lost.
1539 void
1540 pop_close (server)
1541 popserver server;
1543 pop_trash (server);
1544 free ((char *) server);
1546 return;
1550 * Function: pop_trash
1552 * Purpose: Like pop_close or pop_quit, but doesn't deallocate the
1553 * memory associated with the server. It is legal to call
1554 * pop_close or pop_quit after this function has been called.
1556 static void
1557 pop_trash (server)
1558 popserver server;
1560 if (server->file >= 0)
1562 /* avoid recursion; sendline can call pop_trash */
1563 if (server->trash_started)
1564 return;
1565 server->trash_started = 1;
1567 sendline (server, "RSET");
1568 sendline (server, "QUIT");
1570 CLOSESOCKET (server->file);
1571 server->file = -1;
1572 if (server->buffer)
1574 free (server->buffer);
1575 server->buffer = 0;
1579 #ifdef WINDOWSNT
1580 if (have_winsock)
1581 WSACleanup ();
1582 #endif
1585 /* Return a pointer to the first CRLF in IN_STRING, which can contain
1586 embedded nulls and has LEN characters in it not including the final
1587 null, or 0 if it does not contain one. */
1589 static char *
1590 find_crlf (in_string, len)
1591 char *in_string;
1592 int len;
1594 while (len--)
1596 if (*in_string == '\r')
1598 if (*++in_string == '\n')
1599 return (in_string - 1);
1601 else
1602 in_string++;
1604 return (0);
1607 #endif /* MAIL_USE_POP */