Many doc fixes.
[emacs.git] / lib-src / pop.c
blob46a60195aff1749aa9583db07042d9a7553d41e4
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 <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 160 /* a pretty arbitrary size, but needs
142 to be bigger than the original
143 value of 80 */
144 #define POP_PORT 110
145 #define KPOP_PORT 1109
146 #define POP_SERVICE "pop3" /* we don't want the POP2 port! */
147 #ifdef KERBEROS
148 #define KPOP_SERVICE "kpop"
149 #endif
151 char pop_error[ERROR_MAX];
152 int pop_debug = 0;
154 #ifndef min
155 #define min(a,b) (((a) < (b)) ? (a) : (b))
156 #endif
159 * Function: pop_open (char *host, char *username, char *password,
160 * int flags)
162 * Purpose: Establishes a connection with a post-office server, and
163 * completes the authorization portion of the session.
165 * Arguments:
166 * host The server host with which the connection should be
167 * established. Optional. If omitted, internal
168 * heuristics will be used to determine the server host,
169 * if possible.
170 * username
171 * The username of the mail-drop to access. Optional.
172 * If omitted, internal heuristics will be used to
173 * determine the username, if possible.
174 * password
175 * The password to use for authorization. If omitted,
176 * internal heuristics will be used to determine the
177 * password, if possible.
178 * flags A bit mask containing flags controlling certain
179 * functions of the routine. Valid flags are defined in
180 * the file pop.h
182 * Return value: Upon successful establishment of a connection, a
183 * non-null popserver will be returned. Otherwise, null will be
184 * returned, and the string variable pop_error will contain an
185 * explanation of the error.
187 popserver
188 pop_open (host, username, password, flags)
189 char *host;
190 char *username;
191 char *password;
192 int flags;
194 int sock;
195 popserver server;
197 /* Determine the user name */
198 if (! username)
200 username = getenv ("USER");
201 if (! (username && *username))
203 username = getlogin ();
204 if (! (username && *username))
206 struct passwd *passwd;
207 passwd = getpwuid (getuid ());
208 if (passwd && passwd->pw_name && *passwd->pw_name)
210 username = passwd->pw_name;
212 else
214 strcpy (pop_error, "Could not determine username");
215 return (0);
222 * Determine the mail host.
225 if (! host)
227 host = getenv ("MAILHOST");
230 #ifdef HESIOD
231 if ((! host) && (! (flags & POP_NO_HESIOD)))
233 struct hes_postoffice *office;
234 office = hes_getmailhost (username);
235 if (office && office->po_type && (! strcmp (office->po_type, "POP"))
236 && office->po_name && *office->po_name && office->po_host
237 && *office->po_host)
239 host = office->po_host;
240 username = office->po_name;
243 #endif
245 #ifdef MAILHOST
246 if (! host)
248 host = MAILHOST;
250 #endif
252 if (! host)
254 strcpy (pop_error, "Could not determine POP server");
255 return (0);
258 /* Determine the password */
259 #ifdef KERBEROS
260 #define DONT_NEED_PASSWORD (! (flags & POP_NO_KERBEROS))
261 #else
262 #define DONT_NEED_PASSWORD 0
263 #endif
265 if ((! password) && (! DONT_NEED_PASSWORD))
267 if (! (flags & POP_NO_GETPASS))
269 password = getpass ("Enter POP password:");
271 if (! password)
273 strcpy (pop_error, "Could not determine POP password");
274 return (0);
277 if (password)
278 flags |= POP_NO_KERBEROS;
279 else
280 password = username;
282 sock = socket_connection (host, flags);
283 if (sock == -1)
284 return (0);
286 server = (popserver) malloc (sizeof (struct _popserver));
287 if (! server)
289 strcpy (pop_error, "Out of memory in pop_open");
290 return (0);
292 server->buffer = (char *) malloc (GETLINE_MIN);
293 if (! server->buffer)
295 strcpy (pop_error, "Out of memory in pop_open");
296 free ((char *) server);
297 return (0);
300 server->file = sock;
301 server->data = 0;
302 server->buffer_index = 0;
303 server->buffer_size = GETLINE_MIN;
304 server->in_multi = 0;
305 server->trash_started = 0;
307 if (getok (server))
308 return (0);
311 * I really shouldn't use the pop_error variable like this, but....
313 if (strlen (username) > ERROR_MAX - 6)
315 pop_close (server);
316 strcpy (pop_error,
317 "Username too long; recompile pop.c with larger ERROR_MAX");
318 return (0);
320 sprintf (pop_error, "USER %s", username);
322 if (sendline (server, pop_error) || getok (server))
324 return (0);
327 if (strlen (password) > ERROR_MAX - 6)
329 pop_close (server);
330 strcpy (pop_error,
331 "Password too long; recompile pop.c with larger ERROR_MAX");
332 return (0);
334 sprintf (pop_error, "PASS %s", password);
336 if (sendline (server, pop_error) || getok (server))
338 return (0);
341 return (server);
345 * Function: pop_stat
347 * Purpose: Issue the STAT command to the server and return (in the
348 * value parameters) the number of messages in the maildrop and
349 * the total size of the maildrop.
351 * Return value: 0 on success, or non-zero with an error in pop_error
352 * in failure.
354 * Side effects: On failure, may make further operations on the
355 * connection impossible.
358 pop_stat (server, count, size)
359 popserver server;
360 int *count;
361 int *size;
363 char *fromserver;
365 if (server->in_multi)
367 strcpy (pop_error, "In multi-line query in pop_stat");
368 return (-1);
371 if (sendline (server, "STAT") || (pop_getline (server, &fromserver) < 0))
372 return (-1);
374 if (strncmp (fromserver, "+OK ", 4))
376 if (0 == strncmp (fromserver, "-ERR", 4))
378 strncpy (pop_error, fromserver, ERROR_MAX);
380 else
382 strcpy (pop_error,
383 "Unexpected response from POP server in pop_stat");
384 pop_trash (server);
386 return (-1);
389 *count = atoi (&fromserver[4]);
391 fromserver = index (&fromserver[4], ' ');
392 if (! fromserver)
394 strcpy (pop_error,
395 "Badly formatted response from server in pop_stat");
396 pop_trash (server);
397 return (-1);
400 *size = atoi (fromserver + 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 return (atoi (&fromserver[4]));
930 * Function: pop_reset
932 * Purpose: Reset the server to its initial connect state
934 * Arguments:
935 * server The server.
937 * Return value: 0 for success, non-0 with error in pop_error
938 * otherwise.
940 * Side effects: Closes the connection on error.
943 pop_reset (server)
944 popserver server;
946 if (pop_retrieve_flush (server))
948 return (-1);
951 if (sendline (server, "RSET") || getok (server))
952 return (-1);
954 return (0);
958 * Function: pop_quit
960 * Purpose: Quit the connection to the server,
962 * Arguments:
963 * server The server to quit.
965 * Return value: 0 for success, non-zero otherwise with error in
966 * pop_error.
968 * Side Effects: The popserver passed in is unusable after this
969 * function is called, even if an error occurs.
972 pop_quit (server)
973 popserver server;
975 int ret = 0;
977 if (server->file >= 0)
979 if (pop_retrieve_flush (server))
981 ret = -1;
984 if (sendline (server, "QUIT") || getok (server))
986 ret = -1;
989 close (server->file);
992 if (server->buffer)
993 free (server->buffer);
994 free ((char *) server);
996 return (ret);
999 #ifdef WINDOWSNT
1000 static int have_winsock = 0;
1001 #endif
1004 * Function: socket_connection
1006 * Purpose: Opens the network connection with the mail host, without
1007 * doing any sort of I/O with it or anything.
1009 * Arguments:
1010 * host The host to which to connect.
1011 * flags Option flags.
1013 * Return value: A file descriptor indicating the connection, or -1
1014 * indicating failure, in which case an error has been copied
1015 * into pop_error.
1017 static int
1018 socket_connection (host, flags)
1019 char *host;
1020 int flags;
1022 struct hostent *hostent;
1023 struct servent *servent;
1024 struct sockaddr_in addr;
1025 char found_port = 0;
1026 char *service;
1027 int sock;
1028 #ifdef KERBEROS
1029 #ifdef KERBEROS5
1030 krb5_error_code rem;
1031 krb5_context kcontext = 0;
1032 krb5_auth_context auth_context = 0;
1033 krb5_ccache ccdef;
1034 krb5_principal client, server;
1035 krb5_error *err_ret;
1036 register char *cp;
1037 #else
1038 KTEXT ticket;
1039 MSG_DAT msg_data;
1040 CREDENTIALS cred;
1041 Key_schedule schedule;
1042 int rem;
1043 char *realhost;
1044 #endif /* KERBEROS5 */
1045 #endif /* KERBEROS */
1047 int try_count = 0;
1049 #ifdef WINDOWSNT
1051 WSADATA winsockData;
1052 if (WSAStartup (0x101, &winsockData) == 0)
1053 have_winsock = 1;
1055 #endif
1057 bzero ((char *) &addr, sizeof (addr));
1058 addr.sin_family = AF_INET;
1060 #ifdef KERBEROS
1061 service = (flags & POP_NO_KERBEROS) ? POP_SERVICE : KPOP_SERVICE;
1062 #else
1063 service = POP_SERVICE;
1064 #endif
1066 #ifdef HESIOD
1067 if (! (flags & POP_NO_HESIOD))
1069 servent = hes_getservbyname (service, "tcp");
1070 if (servent)
1072 addr.sin_port = servent->s_port;
1073 found_port = 1;
1076 #endif
1077 if (! found_port)
1079 servent = getservbyname (service, "tcp");
1080 if (servent)
1082 addr.sin_port = servent->s_port;
1084 else
1086 #ifdef KERBEROS
1087 addr.sin_port = htons ((flags & POP_NO_KERBEROS) ?
1088 POP_PORT : KPOP_PORT);
1089 #else
1090 addr.sin_port = htons (POP_PORT);
1091 #endif
1095 #define POP_SOCKET_ERROR "Could not create socket for POP connection: "
1097 sock = socket (PF_INET, SOCK_STREAM, 0);
1098 if (sock < 0)
1100 strcpy (pop_error, POP_SOCKET_ERROR);
1101 strncat (pop_error, strerror (errno),
1102 ERROR_MAX - sizeof (POP_SOCKET_ERROR));
1103 return (-1);
1109 hostent = gethostbyname (host);
1110 try_count++;
1111 if ((! hostent) && ((h_errno != TRY_AGAIN) || (try_count == 5)))
1113 strcpy (pop_error, "Could not determine POP server's address");
1114 return (-1);
1116 } while (! hostent);
1118 while (*hostent->h_addr_list)
1120 bcopy (*hostent->h_addr_list, (char *) &addr.sin_addr,
1121 hostent->h_length);
1122 if (! connect (sock, (struct sockaddr *) &addr, sizeof (addr)))
1123 break;
1124 hostent->h_addr_list++;
1127 #define CONNECT_ERROR "Could not connect to POP server: "
1129 if (! *hostent->h_addr_list)
1131 CLOSESOCKET (sock);
1132 strcpy (pop_error, CONNECT_ERROR);
1133 strncat (pop_error, strerror (errno),
1134 ERROR_MAX - sizeof (CONNECT_ERROR));
1135 return (-1);
1139 #ifdef KERBEROS
1140 #define KRB_ERROR "Kerberos error connecting to POP server: "
1141 if (! (flags & POP_NO_KERBEROS))
1143 #ifdef KERBEROS5
1144 if ((rem = krb5_init_context (&kcontext)))
1146 krb5error:
1147 if (auth_context)
1148 krb5_auth_con_free (kcontext, auth_context);
1149 if (kcontext)
1150 krb5_free_context (kcontext);
1151 strcpy (pop_error, KRB_ERROR);
1152 strncat (pop_error, error_message (rem),
1153 ERROR_MAX - sizeof(KRB_ERROR));
1154 CLOSESOCKET (sock);
1155 return (-1);
1158 if ((rem = krb5_auth_con_init (kcontext, &auth_context)))
1159 goto krb5error;
1161 if (rem = krb5_cc_default (kcontext, &ccdef))
1162 goto krb5error;
1164 if (rem = krb5_cc_get_principal (kcontext, ccdef, &client))
1165 goto krb5error;
1167 for (cp = hostent->h_name; *cp; cp++)
1169 if (isupper (*cp))
1171 *cp = tolower (*cp);
1175 if (rem = krb5_sname_to_principal (kcontext, hostent->h_name,
1176 POP_SERVICE, FALSE, &server))
1177 goto krb5error;
1179 rem = krb5_sendauth (kcontext, &auth_context,
1180 (krb5_pointer) &sock, "KPOPV1.0", client, server,
1181 AP_OPTS_MUTUAL_REQUIRED,
1182 0, /* no checksum */
1183 0, /* no creds, use ccache instead */
1184 ccdef,
1185 &err_ret,
1186 0, /* don't need subsession key */
1187 0); /* don't need reply */
1188 krb5_free_principal (kcontext, server);
1189 if (rem)
1191 if (err_ret && err_ret->text.length)
1193 strcpy (pop_error, KRB_ERROR);
1194 strncat (pop_error, error_message (rem),
1195 ERROR_MAX - sizeof (KRB_ERROR));
1196 strncat (pop_error, " [server says '",
1197 ERROR_MAX - strlen (pop_error) - 1);
1198 strncat (pop_error, err_ret->text.data,
1199 min (ERROR_MAX - strlen (pop_error) - 1,
1200 err_ret->text.length));
1201 strncat (pop_error, "']",
1202 ERROR_MAX - strlen (pop_error) - 1);
1204 else
1206 strcpy (pop_error, KRB_ERROR);
1207 strncat (pop_error, error_message (rem),
1208 ERROR_MAX - sizeof (KRB_ERROR));
1210 if (err_ret)
1211 krb5_free_error (kcontext, err_ret);
1212 krb5_auth_con_free (kcontext, auth_context);
1213 krb5_free_context (kcontext);
1215 CLOSESOCKET (sock);
1216 return (-1);
1218 #else /* ! KERBEROS5 */
1219 ticket = (KTEXT) malloc (sizeof (KTEXT_ST));
1220 realhost = strdup (hostent->h_name);
1221 rem = krb_sendauth (0L, sock, ticket, "pop", realhost,
1222 (char *) krb_realmofhost (realhost),
1223 (unsigned long) 0, &msg_data, &cred, schedule,
1224 (struct sockaddr_in *) 0,
1225 (struct sockaddr_in *) 0,
1226 "KPOPV0.1");
1227 free ((char *) ticket);
1228 free (realhost);
1229 if (rem != KSUCCESS)
1231 strcpy (pop_error, KRB_ERROR);
1232 strncat (pop_error, krb_err_txt[rem],
1233 ERROR_MAX - sizeof (KRB_ERROR));
1234 CLOSESOCKET (sock);
1235 return (-1);
1237 #endif /* KERBEROS5 */
1239 #endif /* KERBEROS */
1241 return (sock);
1242 } /* socket_connection */
1245 * Function: pop_getline
1247 * Purpose: Get a line of text from the connection and return a
1248 * pointer to it. The carriage return and linefeed at the end of
1249 * the line are stripped, but periods at the beginnings of lines
1250 * are NOT dealt with in any special way.
1252 * Arguments:
1253 * server The server from which to get the line of text.
1255 * Returns: The number of characters in the line, which is returned in
1256 * LINE, not including the final null. A return value of 0
1257 * indicates a blank line. A negative return value indicates an
1258 * error (in which case the contents of LINE are undefined. In
1259 * case of error, an error message is copied into pop_error.
1261 * Notes: The line returned is overwritten with each call to pop_getline.
1263 * Side effects: Closes the connection on error.
1265 * THE RETURNED LINE MAY CONTAIN EMBEDDED NULLS!
1267 static int
1268 pop_getline (server, line)
1269 popserver server;
1270 char **line;
1272 #define GETLINE_ERROR "Error reading from server: "
1274 int ret;
1275 int search_offset = 0;
1277 if (server->data)
1279 char *cp = find_crlf (server->buffer + server->buffer_index,
1280 server->data);
1281 if (cp)
1283 int found;
1284 int data_used;
1286 found = server->buffer_index;
1287 data_used = (cp + 2) - server->buffer - found;
1289 *cp = '\0'; /* terminate the string to be returned */
1290 server->data -= data_used;
1291 server->buffer_index += data_used;
1293 if (pop_debug)
1294 /* Embedded nulls will truncate this output prematurely,
1295 but that's OK because it's just for debugging anyway. */
1296 fprintf (stderr, "<<< %s\n", server->buffer + found);
1297 *line = server->buffer + found;
1298 return (data_used - 2);
1300 else
1302 bcopy (server->buffer + server->buffer_index,
1303 server->buffer, server->data);
1304 /* Record the fact that we've searched the data already in
1305 the buffer for a CRLF, so that when we search below, we
1306 don't have to search the same data twice. There's a "-
1307 1" here to account for the fact that the last character
1308 of the data we have may be the CR of a CRLF pair, of
1309 which we haven't read the second half yet, so we may have
1310 to search it again when we read more data. */
1311 search_offset = server->data - 1;
1312 server->buffer_index = 0;
1315 else
1317 server->buffer_index = 0;
1320 while (1)
1322 /* There's a "- 1" here to leave room for the null that we put
1323 at the end of the read data below. We put the null there so
1324 that find_crlf knows where to stop when we call it. */
1325 if (server->data == server->buffer_size - 1)
1327 server->buffer_size += GETLINE_INCR;
1328 server->buffer = (char *)realloc (server->buffer, server->buffer_size);
1329 if (! server->buffer)
1331 strcpy (pop_error, "Out of memory in pop_getline");
1332 pop_trash (server);
1333 return (-1);
1336 ret = RECV (server->file, server->buffer + server->data,
1337 server->buffer_size - server->data - 1, 0);
1338 if (ret < 0)
1340 strcpy (pop_error, GETLINE_ERROR);
1341 strncat (pop_error, strerror (errno),
1342 ERROR_MAX - sizeof (GETLINE_ERROR));
1343 pop_trash (server);
1344 return (-1);
1346 else if (ret == 0)
1348 strcpy (pop_error, "Unexpected EOF from server in pop_getline");
1349 pop_trash (server);
1350 return (-1);
1352 else
1354 char *cp;
1355 server->data += ret;
1356 server->buffer[server->data] = '\0';
1358 cp = find_crlf (server->buffer + search_offset,
1359 server->data - search_offset);
1360 if (cp)
1362 int data_used = (cp + 2) - server->buffer;
1363 *cp = '\0';
1364 server->data -= data_used;
1365 server->buffer_index = data_used;
1367 if (pop_debug)
1368 fprintf (stderr, "<<< %s\n", server->buffer);
1369 *line = server->buffer;
1370 return (data_used - 2);
1372 /* As above, the "- 1" here is to account for the fact that
1373 we may have read a CR without its accompanying LF. */
1374 search_offset += ret - 1;
1378 /* NOTREACHED */
1382 * Function: sendline
1384 * Purpose: Sends a line of text to the POP server. The line of text
1385 * passed into this function should NOT have the carriage return
1386 * and linefeed on the end of it. Periods at beginnings of lines
1387 * will NOT be treated specially by this function.
1389 * Arguments:
1390 * server The server to which to send the text.
1391 * line The line of text to send.
1393 * Return value: Upon successful completion, a value of 0 will be
1394 * returned. Otherwise, a non-zero value will be returned, and
1395 * an error will be copied into pop_error.
1397 * Side effects: Closes the connection on error.
1399 static int
1400 sendline (server, line)
1401 popserver server;
1402 char *line;
1404 #define SENDLINE_ERROR "Error writing to POP server: "
1405 int ret;
1407 ret = fullwrite (server->file, line, strlen (line));
1408 if (ret >= 0)
1409 { /* 0 indicates that a blank line was written */
1410 ret = fullwrite (server->file, "\r\n", 2);
1413 if (ret < 0)
1415 pop_trash (server);
1416 strcpy (pop_error, SENDLINE_ERROR);
1417 strncat (pop_error, strerror (errno),
1418 ERROR_MAX - sizeof (SENDLINE_ERROR));
1419 return (ret);
1422 if (pop_debug)
1423 fprintf (stderr, ">>> %s\n", line);
1425 return (0);
1429 * Procedure: fullwrite
1431 * Purpose: Just like write, but keeps trying until the entire string
1432 * has been written.
1434 * Return value: Same as write. Pop_error is not set.
1436 static int
1437 fullwrite (fd, buf, nbytes)
1438 int fd;
1439 char *buf;
1440 int nbytes;
1442 char *cp;
1443 int ret = 0;
1445 cp = buf;
1446 while (nbytes && ((ret = SEND (fd, cp, nbytes, 0)) > 0))
1448 cp += ret;
1449 nbytes -= ret;
1452 return (ret);
1456 * Procedure getok
1458 * Purpose: Reads a line from the server. If the return indicator is
1459 * positive, return with a zero exit status. If not, return with
1460 * a negative exit status.
1462 * Arguments:
1463 * server The server to read from.
1465 * Returns: 0 for success, else for failure and puts error in pop_error.
1467 * Side effects: On failure, may make the connection unusable.
1469 static int
1470 getok (server)
1471 popserver server;
1473 char *fromline;
1475 if (pop_getline (server, &fromline) < 0)
1477 return (-1);
1480 if (! strncmp (fromline, "+OK", 3))
1481 return (0);
1482 else if (! strncmp (fromline, "-ERR", 4))
1484 strncpy (pop_error, fromline, ERROR_MAX);
1485 pop_error[ERROR_MAX-1] = '\0';
1486 return (-1);
1488 else
1490 strcpy (pop_error,
1491 "Unexpected response from server; expecting +OK or -ERR");
1492 pop_trash (server);
1493 return (-1);
1497 #if 0
1499 * Function: gettermination
1501 * Purpose: Gets the next line and verifies that it is a termination
1502 * line (nothing but a dot).
1504 * Return value: 0 on success, non-zero with pop_error set on error.
1506 * Side effects: Closes the connection on error.
1508 static int
1509 gettermination (server)
1510 popserver server;
1512 char *fromserver;
1514 if (pop_getline (server, &fromserver) < 0)
1515 return (-1);
1517 if (strcmp (fromserver, "."))
1519 strcpy (pop_error,
1520 "Unexpected response from server in gettermination");
1521 pop_trash (server);
1522 return (-1);
1525 return (0);
1527 #endif
1530 * Function pop_close
1532 * Purpose: Close a pop connection, sending a "RSET" command to try to
1533 * preserve any changes that were made and a "QUIT" command to
1534 * try to get the server to quit, but ignoring any responses that
1535 * are received.
1537 * Side effects: The server is unusable after this function returns.
1538 * Changes made to the maildrop since the session was started (or
1539 * since the last pop_reset) may be lost.
1541 void
1542 pop_close (server)
1543 popserver server;
1545 pop_trash (server);
1546 free ((char *) server);
1548 return;
1552 * Function: pop_trash
1554 * Purpose: Like pop_close or pop_quit, but doesn't deallocate the
1555 * memory associated with the server. It is legal to call
1556 * pop_close or pop_quit after this function has been called.
1558 static void
1559 pop_trash (server)
1560 popserver server;
1562 if (server->file >= 0)
1564 /* avoid recursion; sendline can call pop_trash */
1565 if (server->trash_started)
1566 return;
1567 server->trash_started = 1;
1569 sendline (server, "RSET");
1570 sendline (server, "QUIT");
1572 CLOSESOCKET (server->file);
1573 server->file = -1;
1574 if (server->buffer)
1576 free (server->buffer);
1577 server->buffer = 0;
1581 #ifdef WINDOWSNT
1582 if (have_winsock)
1583 WSACleanup ();
1584 #endif
1587 /* Return a pointer to the first CRLF in IN_STRING, which can contain
1588 embedded nulls and has LEN characters in it not including the final
1589 null, or 0 if it does not contain one. */
1591 static char *
1592 find_crlf (in_string, len)
1593 char *in_string;
1594 int len;
1596 while (len--)
1598 if (*in_string == '\r')
1600 if (*++in_string == '\n')
1601 return (in_string - 1);
1603 else
1604 in_string++;
1606 return (0);
1609 #endif /* MAIL_USE_POP */