lws-context-vhost.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 Andy Green <andy@warmcat.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 of the License.
 *
 *  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
 *
 * included from libwebsockets.h
 */
 
 
/*
 * NOTE: These public enums are part of the abi.  If you want to add one,
 * add it at where specified so existing users are unaffected.
 */
 
enum lws_context_options {
        LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT     = (1 << 1) |
                                                                  (1 << 12),
        LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME            = (1 << 2),
        LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT             = (1 << 3) |
                                                                  (1 << 12),
        LWS_SERVER_OPTION_LIBEV                                 = (1 << 4),
        LWS_SERVER_OPTION_DISABLE_IPV6                          = (1 << 5),
        LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS                   = (1 << 6),
        LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED                = (1 << 7),
        LWS_SERVER_OPTION_VALIDATE_UTF8                         = (1 << 8),
        LWS_SERVER_OPTION_SSL_ECDH                              = (1 << 9) |
                                                                  (1 << 12),
        LWS_SERVER_OPTION_LIBUV                                 = (1 << 10),
        LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS                = (1 << 11) |
                                                                  (1 << 12),
        LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT                    = (1 << 12),
        LWS_SERVER_OPTION_EXPLICIT_VHOSTS                       = (1 << 13),
        LWS_SERVER_OPTION_UNIX_SOCK                             = (1 << 14),
        LWS_SERVER_OPTION_STS                                   = (1 << 15),
        LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY                    = (1 << 16),
        LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE                     = (1 << 17),
        LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN             = (1 << 18),
        LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN                   = (1 << 19),
        LWS_SERVER_OPTION_FALLBACK_TO_RAW                       = (1 << 20),
        LWS_SERVER_OPTION_LIBEVENT                              = (1 << 21),
        LWS_SERVER_OPTION_ONLY_RAW                              = (1 << 22),
        LWS_SERVER_OPTION_ALLOW_LISTEN_SHARE                    = (1 << 23),
        LWS_SERVER_OPTION_CREATE_VHOST_SSL_CTX                  = (1 << 24),
        LWS_SERVER_OPTION_SKIP_PROTOCOL_INIT                    = (1 << 25),
        LWS_SERVER_OPTION_IGNORE_MISSING_CERT                   = (1 << 26),
        LWS_SERVER_OPTION_VHOST_UPG_STRICT_HOST_CHECK           = (1 << 27),
        LWS_SERVER_OPTION_HTTP_HEADERS_SECURITY_BEST_PRACTICES_ENFORCE  = (1 << 28),
        /****** add new things just above ---^ ******/
};
 
#define lws_check_opt(c, f) (((c) & (f)) == (f))
 
struct lws_plat_file_ops;
 
struct lws_context_creation_info {
        int port;
        const char *iface;
        const struct lws_protocols *protocols;
        const struct lws_extension *extensions;
        const struct lws_token_limits *token_limits;
        const char *ssl_private_key_password;
        const char *ssl_cert_filepath;
        const char *ssl_private_key_filepath;
        const char *ssl_ca_filepath;
        const char *ssl_cipher_list;
        const char *http_proxy_address;
        unsigned int http_proxy_port;
        int gid;
        int uid;
        unsigned int options;
        void *user;
        int ka_time;
        int ka_probes;
        int ka_interval;
#if defined(LWS_WITH_TLS) && !defined(LWS_WITH_MBEDTLS)
        SSL_CTX *provided_client_ssl_ctx;
#else /* maintain structure layout either way */
        void *provided_client_ssl_ctx; 
#endif
 
        unsigned short max_http_header_data;
        unsigned short max_http_header_pool;
        unsigned int count_threads;
        unsigned int fd_limit_per_thread;
        unsigned int timeout_secs;
        const char *ecdh_curve;
        const char *vhost_name;
        const char * const *plugin_dirs;
        const struct lws_protocol_vhost_options *pvo;
        int keepalive_timeout;
        const char *log_filepath;
        const struct lws_http_mount *mounts;
        const char *server_string;
        unsigned int pt_serv_buf_size;
        unsigned int max_http_header_data2;
        long ssl_options_set;
        long ssl_options_clear;
        unsigned short ws_ping_pong_interval;
        const struct lws_protocol_vhost_options *headers;
        const struct lws_protocol_vhost_options *reject_service_keywords;
        void *external_baggage_free_on_destroy;
        const char *client_ssl_private_key_password;
        const char *client_ssl_cert_filepath;
        const char *client_ssl_private_key_filepath;
        const char *client_ssl_ca_filepath;
        const void *client_ssl_ca_mem;
        unsigned int client_ssl_ca_mem_len;
        const char *client_ssl_cipher_list;
        const struct lws_plat_file_ops *fops;
        int simultaneous_ssl_restriction;
        const char *socks_proxy_address;
        unsigned int socks_proxy_port;
#if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
        cap_value_t caps[4];
        char count_caps;
#endif
        int bind_iface;
        int ssl_info_event_mask;
        unsigned int timeout_secs_ah_idle;
        unsigned short ip_limit_ah;
        unsigned short ip_limit_wsi;
        uint32_t        http2_settings[7];
        const char *error_document_404;
        const char *alpn;
        void **foreign_loops;
        void (*signal_cb)(void *event_lib_handle, int signum);
        struct lws_context **pcontext;
        void (*finalize)(struct lws_vhost *vh, void *arg);
        void *finalize_arg;
        unsigned int max_http_header_pool2;
        long ssl_client_options_set;
        long ssl_client_options_clear;
        const char *tls1_3_plus_cipher_list;
        const char *client_tls_1_3_plus_cipher_list;
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility
         *
         * The below is to ensure later library versions with new
         * members added above will see 0 (default) even if the app
         * was not built against the newer headers.
         */
 
        void *_unused[4]; 
};
 
LWS_VISIBLE LWS_EXTERN struct lws_context *
lws_create_context(const struct lws_context_creation_info *info);
 
 
LWS_VISIBLE LWS_EXTERN void
lws_context_destroy(struct lws_context *context);
 
typedef int (*lws_reload_func)(void);
 
LWS_VISIBLE LWS_EXTERN void
lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
 
LWS_VISIBLE LWS_EXTERN int
lws_context_is_deprecated(struct lws_context *context);
 
LWS_VISIBLE LWS_EXTERN int
lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
 
LWS_VISIBLE LWS_EXTERN int
lws_set_socks(struct lws_vhost *vhost, const char *socks);
 
struct lws_vhost;
 
LWS_VISIBLE LWS_EXTERN struct lws_vhost *
lws_create_vhost(struct lws_context *context,
                 const struct lws_context_creation_info *info);
 
LWS_VISIBLE LWS_EXTERN void
lws_vhost_destroy(struct lws_vhost *vh);
 
LWS_VISIBLE LWS_EXTERN int
lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
                         char **config_strings, int *len);
 
LWS_VISIBLE LWS_EXTERN int
lwsws_get_config_vhosts(struct lws_context *context,
                        struct lws_context_creation_info *info, const char *d,
                        char **config_strings, int *len);
 
LWS_VISIBLE LWS_EXTERN struct lws_vhost *
lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
 
LWS_VISIBLE LWS_EXTERN struct lws_vhost *
lws_get_vhost(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN const char *
lws_get_vhost_name(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN int
lws_get_vhost_port(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN void *
lws_get_vhost_user(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN const char *
lws_get_vhost_iface(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN int
lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
 
LWS_VISIBLE LWS_EXTERN int
lws_json_dump_context(const struct lws_context *context, char *buf, int len,
                      int hide_vhosts);
 
LWS_VISIBLE LWS_EXTERN void *
lws_vhost_user(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN void *
lws_context_user(struct lws_context *context);
 
 
struct lws_protocol_vhost_options {
        const struct lws_protocol_vhost_options *next; 
        const struct lws_protocol_vhost_options *options; 
        const char *name; 
        const char *value; 
};
 
enum lws_mount_protocols {
        LWSMPRO_HTTP            = 0, 
        LWSMPRO_HTTPS           = 1, 
        LWSMPRO_FILE            = 2, 
        LWSMPRO_CGI             = 3, 
        LWSMPRO_REDIR_HTTP      = 4, 
        LWSMPRO_REDIR_HTTPS     = 5, 
        LWSMPRO_CALLBACK        = 6, 
};
 
struct lws_http_mount {
        const struct lws_http_mount *mount_next;
        const char *mountpoint;
        const char *origin;
        const char *def;
        const char *protocol;
        const struct lws_protocol_vhost_options *cgienv;
        const struct lws_protocol_vhost_options *extra_mimetypes;
        const struct lws_protocol_vhost_options *interpret;
        int cgi_timeout;
        int cache_max_age;
        unsigned int auth_mask;
        unsigned int cache_reusable:1; 
        unsigned int cache_revalidate:1; 
        unsigned int cache_intermediaries:1; 
        unsigned char origin_protocol; 
        unsigned char mountpoint_len; 
        const char *basic_auth_login_file;
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility
         *
         * The below is to ensure later library versions with new
         * members added above will see 0 (default) even if the app
         * was not built against the newer headers.
         */
 
        void *_unused[2]; 
};