Skip to content

libfetch, fetch: Improve handling of HTTP request body, method, fields, and status code #1859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+474 −66
Open

libfetch, fetch: Improve handling of HTTP request body, method, fields, and status code #1859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b54ab72
lib/libfetch: Add fetchXReqHTTP(3)
ryan-moeller Sep 26, 2025
af6163d
usr.bin/fetch: Handle custom headers and method for HTTP
ryan-moeller Sep 26, 2025
9ac571a
usr.bin/fetch: Add options for HTTP upload data
ryan-moeller Sep 29, 2025
747ae41
lib/libfetch: Accept all HTTP 2xx (Successful) status codes
ryan-moeller Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/libfetch/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ httperr.h: http.errors ${.CURDIR}/Makefile
@echo " { -1, FETCH_UNKNOWN, \"Unknown HTTP error\" }" >> ${.TARGET}
@echo "};" >> ${.TARGET}

MLINKS+= fetch.3 fetchFreeResFields.3
MLINKS+= fetch.3 fetchFreeURL.3
MLINKS+= fetch.3 fetchGet.3
MLINKS+= fetch.3 fetchGetFTP.3
Expand Down Expand Up @@ -77,5 +78,6 @@ MLINKS+= fetch.3 fetchXGetFTP.3
MLINKS+= fetch.3 fetchXGetFile.3
MLINKS+= fetch.3 fetchXGetHTTP.3
MLINKS+= fetch.3 fetchXGetURL.3
MLINKS+= fetch.3 fetchXReqHTTP.3

.include <bsd.lib.mk>
3 changes: 0 additions & 3 deletions lib/libfetch/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,6 @@ int fetch_no_proxy_match(const char *);
*/
FILE *http_request(struct url *, const char *,
struct url_stat *, struct url *, const char *);
FILE *http_request_body(struct url *, const char *,
Copy link
Author

@ryan-moeller ryan-moeller Sep 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is not used outside http.c so while changing the parameters I also made it static.

struct url_stat *, struct url *, const char *,
const char *, const char *);
FILE *ftp_request(struct url *, const char *,
struct url_stat *, struct url *, const char *);

Expand Down
55 changes: 48 additions & 7 deletions lib/libfetch/fetch.3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd October 7, 2023
.Dd September 27, 2025
.Dt FETCH 3
.Os
.Sh NAME
Expand All @@ -51,7 +51,9 @@
.Nm fetchPutHTTP ,
.Nm fetchStatHTTP ,
.Nm fetchListHTTP ,
.Nm fetchXReqHTTP ,
.Nm fetchReqHTTP ,
.Nm fetchFreeResFields ,
.Nm fetchXGetFTP ,
.Nm fetchGetFTP ,
.Nm fetchPutFTP ,
Expand All @@ -62,6 +64,7 @@
.Lb libfetch
.Sh SYNOPSIS
.In sys/param.h
.In sys/queue.h
.In stdio.h
.In fetch.h
.Ft struct url *
Expand Down Expand Up @@ -111,7 +114,11 @@
.Ft struct url_ent *
.Fn fetchListHTTP "struct url *u" "const char *flags"
.Ft FILE *
.Fn fetchXReqHTTP "struct url *u" "struct url_stat *us" "const char *method" "const char *flags" "const struct http_fields *req_headers" "const struct http_fields *req_trailers" "struct http_fields *res_headers" "struct http_fields *res_trailers" "FILE *body"
.Ft FILE *
.Fn fetchReqHTTP "struct url *u" "const char *method" "const char *flags" "const char *content_type" "const char *body"
.Ft void
.Fn fetchFreeResFields "struct http_fields *fields"
.Ft FILE *
.Fn fetchXGetFTP "struct url *u" "struct url_stat *us" "const char *flags"
.Ft FILE *
Expand Down Expand Up @@ -357,7 +364,8 @@ and password "anonymous@<hostname>".
The
.Fn fetchXGetHTTP ,
.Fn fetchGetHTTP ,
.Fn fetchPutHTTP
.Fn fetchPutHTTP ,
.Fn fetchXReqHTTP ,
and
.Fn fetchReqHTTP
functions implement the HTTP/1.1 protocol.
Expand Down Expand Up @@ -389,7 +397,18 @@ will send a conditional
HTTP header to only fetch the content if it is newer than
.Va ims_time .
.Pp
The function
If the
.Ql C
(chunked) flag is specified,
.Fn fetchXReqHTTP
and
.Fn fetchReqHTTP
will send the provided body content as a chunk-encoded stream even if a size can
be predetermined.
.Pp
The functions
.Fn fetchXReqHTTP
and
.Fn fetchReqHTTP
can be used to make requests with an arbitrary HTTP verb,
including POST, DELETE, CONNECT, OPTIONS, TRACE or PATCH.
Expand All @@ -401,10 +420,32 @@ and
.Fa body
to the content.
.Pp
Since there seems to be no good way of implementing the HTTP PUT
method in a manner consistent with the rest of the
.Nm fetch
library,
In addition to returning
.Vt "struct url_stat"
information,
.Fn fetchXReqHTTP
also accepts optional lists of arbitrary additional fields to send,
optional lists to be filled with all response fields received,
and an optional
.Vt "FILE"
stream to send as the body.
The response fields lists should be freed with
.Fn fetchFreeResFields .
The
.Vt http_field
and
.Vt http_fields
structures are defined as follows in
.In fetch.h :
.Bd -literal
struct http_field {
const char *name;
const char *value;
TAILQ_ENTRY(http_field) fields;
};
TAILQ_HEAD(http_fields, http_field);
.Ed
.Pp
.Fn fetchPutHTTP
is currently unimplemented.
.Sh HTTPS SCHEME
Expand Down
18 changes: 17 additions & 1 deletion lib/libfetch/fetch.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#ifndef _FETCH_H_INCLUDED
#define _FETCH_H_INCLUDED

#define _LIBFETCH_VER "libfetch/2.0"
#define _LIBFETCH_VER "libfetch/2.1"

#define URL_SCHEMELEN 16
#define URL_USERLEN 256
Expand Down Expand Up @@ -61,6 +61,15 @@ struct url_ent {
struct url_stat stat;
};

#ifdef _SYS_QUEUE_H_
Copy link
Author

@ryan-moeller ryan-moeller Sep 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The #ifdef _SYS_QUEUE_H_ is a compromise. Currently, fetch.h includes none of the headers it relies on. Rather than changing this, or changing every consumer to include the sys/queue.h header, I added checks for it to only expose the parts that rely on it when the consumer has included it.

I'm open to handling this differently.

struct http_field {
const char *name;
const char *value;
TAILQ_ENTRY(http_field) fields;
};
TAILQ_HEAD(http_fields, http_field);
#endif

/* Recognized schemes */
#define SCHEME_FTP "ftp"
#define SCHEME_HTTP "http"
Expand Down Expand Up @@ -105,6 +114,13 @@ int fetchStatHTTP(struct url *, struct url_stat *, const char *);
struct url_ent *fetchListHTTP(struct url *, const char *);
FILE *fetchReqHTTP(struct url *, const char *, const char *,
const char *, const char *);
#ifdef _SYS_QUEUE_H_
FILE *fetchXReqHTTP(struct url *, struct url_stat *, const char *,
const char *, const struct http_fields *,
const struct http_fields *, struct http_fields *,
struct http_fields *, FILE *);
void fetchFreeResFields(struct http_fields *);
#endif

/* FTP-specific functions */
FILE *fetchXGetFTP(struct url *, struct url_stat *, const char *);
Expand Down
Loading