/* * Project : tin - a Usenet reader * Module : nntplib.h * Author : I.Lea * Created : 1991-04-01 * Updated : 2025-07-29 * Notes : nntp.h 1.5.11/1.6 with extensions for tin * * Copyright (c) 1991-2026 Iain Lea * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * 3. Neither the name of the copyright holder nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #ifndef NNTPLIB_H #define NNTPLIB_H 1 #ifndef NNTP_SERVER_FILE # define NNTP_SERVER_FILE "/etc/nntpserver" #endif /* !NNTP_SERVER_FILE */ #define NNTP_TCP_NAME "nntp" #define NNTP_TCP_PORT "119" #define NNTPS_TCP_NAME "nntps" #define NNTPS_TCP_PORT "563" /* * # times to try and reconnect to server after timeout * TODO: make this configurable via tinrc */ #define NNTP_TRY_RECONNECT 2 /* * @(#)Header: nntp.h,v 1.81 92/03/12 02:08:31 sob Exp $ * * First digit: * * 1xx Informative message * 2xx Command ok * 3xx Command ok so far, continue * 4xx Command was correct, but couldn't be performed * for some specified reason. * 5xx Command unimplemented, incorrect, or a * program error has occurred. * * Second digit: * * x0x Connection, setup, miscellaneous * x1x Newsgroup selection * x2x Article selection * x3x Distribution * x4x Posting */ #if 0 /* unused */ # define CHAR_INF '1' # define CHAR_OK '2' # define CHAR_CONT '3' # define CHAR_ERR '4' # define CHAR_FATAL '5' #endif /* 0 */ /* TODO: cleanup against RFC 2980, RFC 3977, RFC 4643, RFC 6048, RFC 8054 */ #define INF_HELP 100 /* Help text on way */ #define INF_CAPABILITIES 101 /* Capability list follows */ #define INF_DATE 111 /* yyyymmddhhmmss Server date and time */ #define OK_CANPOST 200 /* Hello; you can post */ #define OK_NOPOST 201 /* Hello; you can't post */ #define OK_EXTENSIONS 202 /* extensions supported follow */ #define OK_GOODBYE 205 /* Closing connection */ #define OK_COMPRESS 206 /* Compression active */ #define OK_GROUP 211 /* Group selected */ #define OK_GROUPS 215 /* Newsgroups follow */ #define OK_MOTD 215 /* News motd follows */ #define OK_ARTICLE 220 /* Article (head & body) follows */ #define OK_HEAD 221 /* Head follows */ #define OK_XHDR 221 /* headers follow */ #define OK_XPAT 221 /* headers follow */ #define OK_BODY 222 /* Body follows */ #define OK_NOTEXT 223 /* No text sent -- stat, next, last */ #define OK_XOVER 224 /* .overview data follows */ #define OK_HDR 225 /* headers follow */ #define OK_NEWNEWS 230 /* New articles by message-id follow */ #define OK_NEWGROUPS 231 /* New newsgroups follow */ #define OK_XFERED 235 /* Article transferred successfully */ #define OK_POSTED 240 /* Article posted successfully */ #define OK_AUTHSYS 280 /* Authorization system ok */ #define OK_AUTH 281 /* Authorization (user/pass) ok */ #define OK_BIN 282 /* binary data follows */ #define OK_LIST 282 /* list follows */ #define OK_AUTH_SASL 283 /* authentication accepted (with success data) */ #define CONT_XFER 335 /* Continue to send article */ #define CONT_POST 340 /* Continue to post article */ #define NEED_AUTHINFO 380 /* authorization is required */ #define NEED_AUTHDATA 381 /* authorization data required */ #define NEED_AUTHDATA_SASL 383 /* continue with SASL exchange */ #define ERR_GOODBYE 400 /* Have to hang up for some reason */ #define ERR_CONNSTATE 401 /* The client must change the state of the connection */ #define ERR_COMPRESS 403 /* Unable to activate compression */ #define ERR_NOGROUP 411 /* No such newsgroup */ #define ERR_NCING 412 /* Not currently in newsgroup */ #define ERR_NOCRNT 420 /* No current article selected */ #define ERR_NONEXT 421 /* No next article in this group */ #define ERR_NOPREV 422 /* No previous article in this group */ #define ERR_NOARTIG 423 /* No such article in this group */ #define ERR_NOART 430 /* No such article at all */ #define ERR_GOTIT 435 /* Already got that article, don't send */ #define ERR_XFERFAIL 436 /* Transfer failed */ #define ERR_XFERRJCT 437 /* Article rejected, don't resend */ #define ERR_NOPOST 440 /* Posting not allowed */ #define ERR_POSTFAIL 441 /* Posting failed */ #define ERR_NOAUTH 480 /* authorization required for command */ #define ERR_AUTHFAIL 481 /* Authentication failed/rejected */ #define ERR_AUTHSEQ 482 /* Authentication commands issued out of sequence or SASL protocol error */ #define ERR_ENCRYPT 483 /* encryption required */ #define ERR_COMMAND 500 /* Command not recognized */ #define ERR_CMDSYN 501 /* Command syntax error */ #define ERR_ACCESS 502 /* Access to server denied */ #define ERR_FAULT 503 /* Program fault, command not performed */ #define ERR_MOTD 503 /* No news motd file */ #define ERR_COMPRESS_ALG 503 /* Compression algorithm not supported */ #define ERR_AUTHBAD 580 /* Authorization Failed */ /* * RFC 977 defines this; don't change it. */ #define NNTP_STRLEN 512 /* * RFC 3977 3.1 */ #define NNTP_GRPLEN 497 /* * OVERVIEW.FMT field types */ enum f_type { OVER_T_ERROR, OVER_T_INT, OVER_T_STRING, OVER_T_FSTRING }; /* * CAPABILITIES * remember to update init.c and nntplib.c:check_extensions() if you change * t_capabilities */ enum extension_type { NONE, CAPABILITIES, BROKEN }; enum sasl_props { SASL_NEED_NONE = 0, SASL_NEED_AUTHZID = 1 << 0, SASL_NEED_AUTHID = 1 << 1, SASL_NEED_PASSWORD = 1 << 2, SASL_NEED_SERVICE = 1 << 3, SASL_NEED_ANONYMOUS_TOKEN = 1 << 4, SASL_NEED_HOSTNAME = 1 << 5 /* ... */ }; enum c_algorithms { COMPRESS_NONE, COMPRESS_DEFLATE }; struct t_capabilities { enum extension_type type; /* NONE, CAPABILITIES, BROKEN */ unsigned int version; /* CAPABILITIES version */ t_bool mode_reader:1; /* MODE-READER: "MODE READER" */ t_bool reader:1; /* READER: "ARTICLE", "BODY", "DATE", "GROUP", "LAST", "LISTGROUP", "NEWGROUPS", "NEXT" */ t_bool post:1; /* POST */ t_bool list_active:1; /* LIST ACTIVE */ t_bool list_active_times:1; /* LIST ACTIVE.TIMES, optional */ t_bool list_distrib_pats:1; /* LIST DISTRIB.PATS, optional */ t_bool list_headers:1; /* LIST HEADERS */ char *headers_range; /* list of headers by range */ char *headers_id; /* list of headers by id */ t_bool list_newsgroups:1; /* LIST NEWSGROUPS */ t_bool list_overview_fmt:1; /* LIST OVERVIEW.FMT */ t_bool list_motd:1; /* LIST MOTD, "private" extension */ t_bool list_subscriptions:1; /* LIST SUBSCRIPTIONS, "private" extension, RFC 2980 */ t_bool list_distributions:1; /* LIST DISTRIBUTIONS, "private" extension, RFC 2980 */ t_bool list_moderators:1; /* LIST MODERATORS, "private" extension */ t_bool list_counts:1; /* LIST COUNTS, "private" extension */ t_bool listgroup:1; /* LISTGROUP - old versions of nntpcache (< 2.3.3b1?), leafnode and SurgeNews had a buggy implementation which didn't select the group and would require an extra GROUP cmd. before */ t_bool xpat:1; /* XPAT, "private" extension, RFC 2980 */ t_bool hdr:1; /* HDR: "HDR", "LIST HEADERS" */ const char *hdr_cmd; /* [X]HDR */ t_bool over:1; /* OVER: "OVER", "LIST OVERVIEW.FMT" */ t_bool over_msgid:1; /* OVER: "OVER mid" */ const char *over_cmd; /* [X]OVER */ t_bool newgroups:1; /* NEWGROUPS */ #if 0 /* we don't do NEWNEWS */ t_bool newnews:1; /* NEWNEWS */ #endif /* 0 */ char *implementation; /* IMPLEMENTATION */ t_bool starttls:1; /* STARTTLS (not supported; RFC 7525 3.2, RFC 8143 2) */ t_bool authinfo_user:1; /* AUTHINFO USER/PASS */ t_bool authinfo_sasl:1; /* AUTHINFO SASL */ t_bool authinfo_state:1; /* AUTHINFO not supported in current state (FALSE==auth allowed) */ char *sasl_mechs; /* SASL mechs of the server which our code supports */ char *sasl_mech_used; /* SASL mech in use */ t_bool compress:1; /* COMPRESS */ enum c_algorithms compress_algorithm; /* COMPRESS_NONE, COMPRESS_DEFLATE */ t_distrib_pat *distrib_pats; /* DISTRIB.PATS linked list */ #if defined(MAXARTNUM) && defined(USE_LONG_ARTICLE_NUMBERS) t_artnum maxartnum; /* MAXARTNUM indicating article numbers >=2^31 */ #endif /* MAXARTNUM && USE_LONG_ARTICLE_NUMBERS */ #if 0 /* we don't do MODE STREAM, CHECK, TAKETHIS or IHAVE */ t_bool streaming:1; /* STREAMING: "MODE STREAM", "CHECK", "TAKETHIS" */ t_bool ihave:1; /* IHAVE: "IHAVE" */ #endif /* 0 */ }; #endif /* !NNTPLIB_H */