apps/include/http_server.h

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OSSL_HTTP_SERVER_H
  11 # define OSSL_HTTP_SERVER_H
  12
  13 # include "apps.h"
  14
  15 # ifndef HAVE_FORK
  16 #  if defined(OPENSSL_SYS_VMS) || defined(OPENSSL_SYS_WINDOWS)
  17 #   define HAVE_FORK 0
  18 #  else
  19 #   define HAVE_FORK 1
  20 #  endif
  21 # endif
  22
  23 # if HAVE_FORK
  24 #  undef NO_FORK
  25 # else
  26 #  define NO_FORK
  27 # endif
  28
  29 # if !defined(NO_FORK) && !defined(OPENSSL_NO_SOCK) \
  30     && !defined(OPENSSL_NO_POSIX_IO)
  31 #  define HTTP_DAEMON
  32 #  include <sys/types.h>
  33 #  include <sys/wait.h>
  34 #  include <syslog.h>
  35 #  include <signal.h>
  36 #  define MAXERRLEN 1000 /* limit error text sent to syslog to 1000 bytes */
  37 # else
  38 #  undef LOG_INFO
  39 #  undef LOG_WARNING
  40 #  undef LOG_ERR
  41 #  define LOG_INFO      0
  42 #  define LOG_WARNING   1
  43 #  define LOG_ERR       2
  44 # endif
  45
  46 /*-
  47  * Log a message to syslog if multi-threaded HTTP_DAEMON, else to bio_err
  48  * prog: the name of the current app
  49  * level: the severity of the message, e.g., LOG_ERR
  50  * fmt: message with potential extra parameters like with printf()
  51  * returns nothing
  52  */
  53 void log_message(const char *prog, int level, const char *fmt, ...);
  54
  55 # ifndef OPENSSL_NO_SOCK
  56 /*-
  57  * Initialize an HTTP server by setting up its listening BIO
  58  * prog: the name of the current app
  59  * port: the port to listen on
  60  * returns a BIO for accepting requests, NULL on error
  61  */
  62 BIO *http_server_init_bio(const char *prog, const char *port);
  63
  64 /*-
  65  * Accept an ASN.1-formatted HTTP request
  66  * it: the expected request ASN.1 type
  67  * preq: pointer to variable where to place the parsed request
  68  * pcbio: pointer to variable where to place the BIO for sending the response to
  69  * ppath: pointer to variable where to place the request path, or NULL
  70  * acbio: the listening bio (typically as returned by http_server_init_bio())
  71  * prog: the name of the current app
  72  * accept_get: whether to accept GET requests (in addition to POST requests)
  73  * timeout: connection timeout (in seconds), or 0 for none/infinite
  74  * returns 0 in case caller should retry, then *preq == *ppath == *pcbio == NULL
  75  * returns -1 on fatal error; also then holds *preq == *ppath == *pcbio == NULL
  76  * returns 1 otherwise. In this case it is guaranteed that *pcbio != NULL while
  77  * *ppath == NULL and *preq == NULL if and only if the request is invalid,
  78  * On return value 1 the caller is responsible for sending an HTTP response,
  79  * using http_server_send_asn1_resp() or http_server_send_status().
  80  * The caller must free any non-NULL *preq, *ppath, and *pcbio pointers.
  81  */
  82 int http_server_get_asn1_req(const ASN1_ITEM *it, ASN1_VALUE **preq,
  83                              char **ppath, BIO **pcbio, BIO *acbio,
  84                              const char *prog, int accept_get, int timeout);
  85
  86 /*-
  87  * Send an ASN.1-formatted HTTP response
  88  * cbio: destination BIO (typically as returned by http_server_get_asn1_req())
  89  *       note: cbio should not do an encoding that changes the output length
  90  * content_type: string identifying the type of the response
  91  * it: the response ASN.1 type
  92  * valit: the response ASN.1 type
  93  * resp: the response to send
  94  * returns 1 on success, 0 on failure
  95  */
  96 int http_server_send_asn1_resp(BIO *cbio, const char *content_type,
  97                                const ASN1_ITEM *it, const ASN1_VALUE *resp);
  98
  99 /*-
 100  * Send a trivial HTTP response, typically to report an error or OK
 101  * cbio: destination BIO (typically as returned by http_server_get_asn1_req())
 102  * status: the status code to send
 103  * reason: the corresponding human-readable string
 104  * returns 1 on success, 0 on failure
 105  */
 106 int http_server_send_status(BIO *cbio, int status, const char *reason);
 107
 108 # endif
 109
 110 # ifdef HTTP_DAEMON
 111 extern int multi;
 112 extern int acfd;
 113
 114 void socket_timeout(int signum);
 115 void spawn_loop(const char *prog);
 116 # endif
 117
 118 #endif