anntp

a nntp implementation in pure C99
Log | Files | Refs | README | LICENSE

commit 0828d8d9f708e72016d48dba85f5b62511961a8c
Author: Mario Rosell R. Martinez <mario@mariorosell.es>
Date:   Wed, 18 Mar 2026 19:12:14 +0100

Initial commit

Diffstat:
ALICENSE | 122+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
AREADME | 54++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aanntp.h | 143+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Atest.c | 2++
4 files changed, 321 insertions(+), 0 deletions(-)

diff --git a/LICENSE b/LICENSE @@ -0,0 +1,122 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. + diff --git a/README b/README @@ -0,0 +1,54 @@ +anntp -- async nntp library in C +================================ + +anntp is a public-domain, TLS-capable, asynchronous C implementation for POSIX systems of the Network News Transfer Protocol (NNTP), used by Usenet and other similar networks. + +It is a single header with no dependencies by default (unless you enable TLS, then it depends on OpenSSL), and implements full RFC 977 and 3977. + +Why +--- + +There is no NNTP implementation that works on C, and it is a pretty damn annoying protocol. + +Usage +----- + +Importing +~~~~~~~~~ + +Anntp is a single-header library. The easiest way is to just add a `3rdpary` directory and inside a submodule with the repo, or just copy the header and update when you want :P. + +Note that in exactly ONE C file you must define `ANNTP_IMPLEMENTATION` before including `anntp.h`. + +Config +~~~~~~ + +Before including `anntp.h`, you can define any of these macros: + +* `ANNTP_BUFSIZE`: Buffer size for all operations, +* `ANNTP_MALLOC`: A memory allocator function (only the name), +* `ANNTP_FREE`: A memory free procedure (again, only the name), +* `ANNTP_API`: A type specifier for all API functions. +* `ANNTP_TLS`: Enable TLS + +Usage +~~~~~ + +Before anything, call the `anntp_init()` routine. + +The entire API is based on the idea of **connections**, a connection abstracts the well, connection (*duh!*) from a client to a server. + +A connection is opened with `anntp_mkconn()`, it takes a server URL, and a bool asking weather to enable TLS or not (ignored if TLS is deactivated), and returns a (*heap-allocated*) connection pointer. It must be closed using `anntp_close()`. + +Use `anntp_send(connection, cmd)` to send a command, and get the message by using `anntp_read(connection)`, it returns an unsigned char. + +TODOs +----- + +* A higher-level API + +License +------- + +ughh, pd? + diff --git a/anntp.h b/anntp.h @@ -0,0 +1,143 @@ +/* + * See LICENSE file or copyright and license details. + */ + +#ifndef ANNTP_H +#define ANNTP_H + +#include <arpa/inet.h> /* for inet_ntoa */ +#include <netdb.h> /* for gethostbyname */ +#include <netinet/in.h> /* for struct in_addr */ +#include <stddef.h> /* for size_t */ +#include <stdio.h> /* for fprintf, perror, stderr */ +#include <stdlib.h> /* for malloc, free */ +#include <string.h> /* for memset, memcpy, strdup */ +#include <sys/socket.h> /* for socket */ +#include <unistd.h> /* for close */ + +/*** config ***/ + +#ifdef _WIN32 +# error This project uses the Anntp library, which is not compatible with Windows, sorry :( +#endif + +#ifndef ANNTP_MALLOC +# define ANNTP_MALLOC malloc +#endif + +#ifndef ANNTP_FREE +# define ANNTP_FREE free +#endif + +#ifndef ANNTP_BUFSIZE +# define ANNTP_BUFSIZE 0x1000 +#endif + +#ifndef ANNTP_API +# define ANNTP_API extern +#endif + +/*** defs ***/ + +#define Bool int +#define true 1 +#define false 0 + +typedef unsigned char uchar_t; + +enum anntp_state { + ANS_OFF, + ANS_CONNECTING, + ANS_READY, + ANS_ERROR, +}; + +typedef enum anntp_state AnntpState; + +typedef struct anntp_connection AnntpConnection; + +struct anntp_connection { + int fd; /* socket file descriptor */ + AnntpState state; /* current connection state */ + Bool use_tls; /* whether to use TLS */ + char* host; /* hostname string */ + struct hostent* host_he; /* resolved host entry from gethostbyname/gethostbyaddr */ + struct in_addr addr; /* resolved IP address */ + uchar_t read_buffer[ANNTP_BUFSIZE]; /* read buffer */ + size_t read_len; /* current length of data in buffer */ +}; + +ANNTP_API AnntpConnection* anntp_mkconn(const char* host, int port); +ANNTP_API void anntp_freeconn(AnntpConnection* conn); +ANNTP_API int anntp_connect(AnntpConnection* conn); +ANNTP_API ssize_t anntp_read(AnntpConnection* conn, uchar_t* buf, size_t bufsize); +ANNTP_API ssize_t anntp_write(AnntpConnection* conn, const uchar_t* buf, size_t bufsize); + +#endif /* ANNTP_H */ + +#ifdef ANNTP_IMPLEMENTATION + +void +anntp_init(void) +{ + /* + * for now, there is nothing to do here... + */ +} + +AnntpConnection* +anntp_mkconn(const char* host, Bool tls) +{ + /* do some initting */ + AnntpConnection* cv = (AnntpConnection*)ANNTP_MALLOC(sizeof(AnntpConnection)); + if (!cv) + return NULL; /* check errno */ + + memset(cv, 0, sizeof(cv)); + cv->host = strdup(host); + cv->use_tls = tls; + cv->state = ANS_OFF; + + /* first, we get a nice nonblocking two-way socket over TCP from the kernel... */ + cv->fd = socket(AF_INET, SOCK_STREAM, SOCK_NONBLOCK); + if (cv->fd < 0) { + perror("anntp - making connection socket"); + goto cleanup; + } + + /* now resolve the host name... */ + struct addrinfo hints, *res = NULL; + memset(&hints, 0, sizeof(hints)); + hints.ai_family = AF_INET; + hints.ai_socktype = SOCK_STREAM; + + /* look mom! i made go in c! */ + int err = getaddrinfo(host, NULL, &hints, &res); + if (err != 0) { + fprintf(stderr, "anntp - cant resolve host `%s': %s", host, gai_strerror(err)); /* if you find whoever made this function of *HELL*, tell him how much i hate him */ + close(cv->fd); + goto cleanup; + } + + if (res) { + struct sockaddr_in* sa = (struct sockaddr_in*)res->ai_addr; + /* store info */ + memcpy(&cv->host_he->h_addr_list, &sa->sin_addr, sizeof(struct in_addr)); + cv->host_he->h_name = strdup(host); + } + + freeaddrinfo(res); + cv->state = ANS_CONNECTING; + + return cv; + +cleanup: + ANNTP_FREE(cv->host); + ANNTP_FREE(cv); + return NULL; +} + + + +#endif /* ANNTP_IMPLEMENTATION */ + diff --git a/test.c b/test.c @@ -0,0 +1,2 @@ +#define ANNTP_IMPLEMENTATION +#include "anntp.h"