RepoMirrors/haproxy
1
0
Fork 0
mirror of http://git.haproxy.org/git/haproxy.git/ synced 2024-12-24 13:42:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
8dabda7497
haproxy/include/proto/http_htx.h

77 lines
4.0 KiB
C
Raw Normal View History

MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
/*
* include/types/http_htx.h
* This file defines function prototypes for HTTP manipulation using the
* internal representation.
*
* Copyright (C) 2018 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, version 2.1
* exclusively.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _PROTO_HTTP_HTX_H
#define _PROTO_HTTP_HTX_H
REORG: include: split buf.h into haproxy/buf-t.h and haproxy/buf.h File buf.h is one common cause of pain in the dependencies. Many files in the code need it to get the struct buffer definition, and a few also need the inlined functions to manipulate a buffer, but the file used to depend on a long chain only for BUG_ON() (addressed by last commit). Now buf.h is split into buf-t.h which only contains the type definitions, and buf.h for all inlined functions. Callers who don't care can continue to use buf.h but files in types/ must only use buf-t.h. sys/types.h had to be added to buf.h to get ssize_t as used by b_move(). It's worth noting that ssize_t is only supposed to be a size_t supporting -1, so b_move() ought to be rethought regarding this. The files were moved to haproxy/ and all their users were updated accordingly. A dependency issue was addressed on fcgi whose C file didn't include buf.h.
2020-05-27 15:22:10 +00:00
#include <haproxy/buf.h>
REORG: include: move ist.h from common/ to import/ Fortunately that file wasn't made dependent upon haproxy since it was integrated, better isolate it before it's too late. Its dependency on api.h was the result of the change from config.h, which in turn wasn't correct. It was changed back to stddef.h for size_t and sys/types.h for ssize_t. The recently added reference to MAX() was changed as it was placed only to avoid a zero length in the non-free-standing version and was causing a build warning in the hpack encoder.
2020-05-27 14:21:26 +00:00
#include <import/ist.h>
MINOR: http-htx: Support different methods to look for header names It is now possible to use different matching methods to look for header names in an HTTP message: * The exact match. It is the default method. http_find_header() uses this method. http_find_str_header() is an alias. * The prefix match. It evals the header names starting by a prefix. http_find_pfx_header() must be called to use this method. * The suffix match. It evals the header names ending by a suffix. http_find_sfx_header() must be called to use this method. * The substring match. It evals the header names containing a string. http_find_sub_header() must be called to use this method. * The regex match. It evals the header names matching a regular expression. http_match_header() must be called to use this method.
2020-05-05 05:42:42 +00:00
#include <common/regex.h>
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
#include <types/http_htx.h>
MINOR: http: Don't store raw HTTP errors in chunks anymore Default HTTP error messages are stored in an array of chunks. And since the HTX was added, these messages are also converted in HTX and stored in another array. But now, the first array is not used anymore because the legacy HTTP mode was removed. So now, only the array with the HTX messages are kept. The other one was removed.
2019-07-17 20:02:08 +00:00
extern struct buffer http_err_chunks[HTTP_ERR_SIZE];
MINOR: http-htx: Store default error messages in a global http reply array Default error messages are stored as a buffer, in http_err_chunks global array. Now, they are also stored as a http reply, in http_err_replies global array.
2020-05-14 07:54:26 +00:00
extern struct http_reply http_err_replies[HTTP_ERR_SIZE];
MEDIUM: http-rules: Support an optional error message in http deny rules It is now possible to set the error message to use when a deny rule is executed. It may be a specific error file, adding "errorfile <file>" : http-request deny deny_status 400 errorfile /etc/haproxy/errorfiles/400badreq.http It may also be an error file from an http-errors section, adding "errorfiles <name>" : http-request deny errorfiles my-errors # use 403 error from "my-errors" section When defined, this error message is set in the HTTP transaction. The tarpit rule is also concerned by this change.
2020-01-14 11:00:28 +00:00
extern struct list http_errors_list;
MEDIUM: proto_htx: Convert all HTTP error messages into HTX During startup, after the configuration parsing, all HTTP error messages (errorloc, errorfile or default messages) are converted into HTX messages and stored in dedicated buffers. We use it to return errors in the HTX analyzers instead of using ugly OOB blocks.
2018-11-29 15:48:49 +00:00
MINOR: htx: Replace the function http_find_stline() by http_get_stline() Now, we only return the start-line. If not found, NULL is returned. No lookup is performed and the HTX message is no more updated. It is now the caller responsibility to update the position of the start-line to the right value. So when it is not found, i.e sl_pos is set to -1, it means the last start-line has been already processed and the next one has not been inserted yet. It is mandatory to rely on this kind of warranty to store 1xx informational responses and final reponse in the same HTX message.
2019-05-13 12:41:27 +00:00
struct htx_sl *http_get_stline(struct htx *htx);
MINOR: http-htx: Add a function to retrieve the headers size of an HTX message http_get_hdrs_size() function may now be used to get the bytes held by headers in an HTX message. It only works if the headers were not already forwarded. Metadata are not counted here.
2020-02-07 15:39:41 +00:00
size_t http_get_hdrs_size(struct htx *htx);
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
int http_find_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full);
MINOR: http-htx: Support different methods to look for header names It is now possible to use different matching methods to look for header names in an HTTP message: * The exact match. It is the default method. http_find_header() uses this method. http_find_str_header() is an alias. * The prefix match. It evals the header names starting by a prefix. http_find_pfx_header() must be called to use this method. * The suffix match. It evals the header names ending by a suffix. http_find_sfx_header() must be called to use this method. * The substring match. It evals the header names containing a string. http_find_sub_header() must be called to use this method. * The regex match. It evals the header names matching a regular expression. http_match_header() must be called to use this method.
2020-05-05 05:42:42 +00:00
int http_find_str_header(const struct htx *htx, const struct ist name, struct http_hdr_ctx *ctx, int full);
int http_find_pfx_header(const struct htx *htx, const struct ist prefix, struct http_hdr_ctx *ctx, int full);
int http_find_sfx_header(const struct htx *htx, const struct ist suffix, struct http_hdr_ctx *ctx, int full);
int http_find_sub_header(const struct htx *htx, const struct ist sub, struct http_hdr_ctx *ctx, int full);
int http_match_header(const struct htx *htx, const struct my_regex *re, struct http_hdr_ctx *ctx, int full);
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
int http_add_header(struct htx *htx, const struct ist n, const struct ist v);
MEDIUM: htx: Don't rely on h1_sl anymore except during H1 header parsing Instead, we now use the htx_sl coming from the HTX message. It avoids to have too H1 specific code in version-agnostic parts. Of course, the concept of the start-line is higly influenced by the H1, but the structure htx_sl can be adapted, if necessary. And many things depend on a start-line during HTTP analyzis. Using the structure htx_sl also avoid boring conversions between HTX version and H1 version.
2018-11-26 20:37:08 +00:00
int http_replace_stline(struct htx *htx, const struct ist p1, const struct ist p2, const struct ist p3);
MINOR: http_htx: Add functions to replace part of the start-line
2018-10-24 08:36:45 +00:00
int http_replace_req_meth(struct htx *htx, const struct ist meth);
int http_replace_req_uri(struct htx *htx, const struct ist uri);
int http_replace_req_path(struct htx *htx, const struct ist path);
int http_replace_req_query(struct htx *htx, const struct ist query);
int http_replace_res_status(struct htx *htx, const struct ist status);
int http_replace_res_reason(struct htx *htx, const struct ist reason);
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
int http_replace_header_value(struct htx *htx, struct http_hdr_ctx *ctx, const struct ist data);
int http_replace_header(struct htx *htx, struct http_hdr_ctx *ctx, const struct ist name, const struct ist value);
int http_remove_header(struct htx *htx, struct http_hdr_ctx *ctx);
MINOR: http-htx: Export functions to update message authority and host These functions will be used by HTTP health checks when a request is formatted before sending it.
2020-04-28 17:57:29 +00:00
int http_update_authority(struct htx *htx, struct htx_sl *sl, const struct ist host);
int http_update_host(struct htx *htx, struct htx_sl *sl, const struct ist uri);
MINOR: http_htx: Add functions to retrieve a specific occurrence of a header There are 2 functions. The first one considers any comma as a delimiter for distinct values. The second one considers full-line headers.
2018-10-24 08:39:35 +00:00
unsigned int http_get_htx_hdr(const struct htx *htx, const struct ist hdr,
int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen);
unsigned int http_get_htx_fhdr(const struct htx *htx, const struct ist hdr,
int occ, struct http_hdr_ctx *ctx, char **vptr, size_t *vlen);
BUG/MINOR: http_htx: Support empty errorfiles Empty error files may be used to disable the sending of any message for specific error codes. A common use-case is to use the file "/dev/null". This way the default error message is overridden and no message is returned to the client. It was supported in the legacy HTTP mode, but not in HTX. Because of a bug, such messages triggered an error. This patch must be backported to 2.0 and 1.9. However, the patch will have to be adapted.
2019-07-22 14:49:30 +00:00
int http_str_to_htx(struct buffer *buf, struct ist raw);
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
MINOR: http-htx: Use a dedicated function to release http_reply objects A function to release an http_reply object has been added. It is now called when an http return rule is released.
2020-05-12 16:57:28 +00:00
void release_http_reply(struct http_reply *http_reply);
MINOR: http-htx: Use a dedicated function to check http reply validity A dedicated function is added to check the validity of an http reply object, after parsing. It is used to check the validity of http return rules. For now, this function is only used to find the right error message in an http-errors section for http replies of type HTTP_REPLY_ERRFILES (using "errorfiles" argument). On success, such replies are updated to point on the corresponding error message and their type is set to HTTP_REPLY_ERRMSG. If an unknown http-errors section is referenced, anx error is returned. If a unknown error message is referenced inside an existing http-errors section, a warning is emitted and the proxy's error messages are used instead.
2020-05-13 13:02:59 +00:00
int http_check_http_reply(struct http_reply *reply, struct proxy*px, char **errmsg);
MINOR: http-htx: Use a dedicated function to parse http reply arguments A dedicated function to parse arguments and create an http_reply object is added. It is used to parse http return rule. Thus, following arguments are parsed by this function : ... [status <code>] [content-type <type>] [ { default-errorfiles | errorfile <file> | errorfiles <name> | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] [ hdr <name> <fmt> ]* Because the status code argument is optional, a default status code must be defined when this function is called.
2020-05-13 12:36:55 +00:00
struct http_reply *http_parse_http_reply(const char **args, int *orig_arg, struct proxy *px,
int default_status, char **errmsg);
MINOR: http-htx: Use a dedicated function to release http_reply objects A function to release an http_reply object has been added. It is now called when an http return rule is released.
2020-05-12 16:57:28 +00:00
MEDIUM: http-htx/proxy: Use a global and centralized storage for HTTP error messages All custom HTTP errors are now stored in a global tree. Proxies use a references on these messages. The key used for errorfile directives is the file name as specified in the configuration. For errorloc directives, a key is created using the redirect code and the url. This means that the same custom error message is now stored only once. It may be used in several proxies or for several status code, it is only parsed and stored once.
2020-01-15 14:19:50 +00:00
struct buffer *http_load_errorfile(const char *file, char **errmsg);
struct buffer *http_load_errormsg(const char *key, const struct ist msg, char **errmsg);
struct buffer *http_parse_errorfile(int status, const char *file, char **errmsg);
struct buffer *http_parse_errorloc(int errloc, int status, const char *url, char **errmsg);
MEDIUM: proxy: Add a directive to reference an http-errors section in a proxy It is now possible to import in a proxy, fully or partially, error files declared in an http-errors section. It may be done using the "errorfiles" directive, followed by a name and optionally a list of status code. If there is no status code specified, all error files of the http-errors section are imported. Otherwise, only error files associated to the listed status code are imported. For instance : http-errors my-errors errorfile 400 ... errorfile 403 ... errorfile 404 ... frontend frt errorfiles my-errors 403 404 # ==> error 400 not imported
2020-01-13 14:52:01 +00:00
int proxy_dup_default_conf_errors(struct proxy *curpx, struct proxy *defpx, char **errmsg);
void proxy_release_conf_errors(struct proxy *px);
MINOR: http-htx: Add functions to read a raw error file and convert it in HTX http_parse_errorfile() may now be used to parse a raw HTTP message from a file. A status code is passed as parameter. It must be one of the supported HTTP error codes to be valid. Otherwise an error is returned. It aims to be used to parse "errorfile" directives. It relies on http_load_errorfile() to do most of the job, ie reading the file content and converting it in HTX.
2020-01-15 10:22:07 +00:00
MINOR: http_htx: Add functions to manipulate HTX messages in http_htx.c This file will host all functions to manipulate HTTP messages using the HTX representation. Functions in this file will be able to be called from anywhere and are mainly related to the HTTP semantics.
2018-10-22 07:17:28 +00:00
#endif /* _PROTO_HTTP_HTX_H */
Reference in New Issue Copy Permalink