1 // webcit.h - "header of headers"
3 // Copyright (c) 1996-2021 by the citadel.org team
5 // This program is open source software. You can redistribute it and/or
6 // modify it under the terms of the GNU General Public License, version 3.
8 #define SHOW_ME_VAPPEND_PRINTF
18 #include <sys/types.h>
19 #include <sys/socket.h>
20 #include <netinet/in.h>
21 #include <arpa/inet.h>
36 #include <libcitadel.h>
37 #define OPENSSL_NO_KRB5 // Work around RedHat's b0rken OpenSSL includes
38 #include <openssl/ssl.h>
39 #include <openssl/err.h>
40 #include <openssl/rand.h>
42 #define _(x) x // temporary hack until we add i18n back in
43 #define DEBUG_HTTP // uncomment to debug HTTP headers
45 // XML_StopParser is present in expat 2.x
46 #if XML_MAJOR_VERSION > 1
47 #define HAVE_XML_STOPPARSER
50 struct client_handle { // this gets passed up the stack from the webserver to the application code
55 struct keyval { // key/value pair (for array)
60 struct key_val_list { // linked list of keys and values
61 struct key_val_list *next;
66 struct http_transaction { // The lifetime of an HTTP request goes through this data structure.
67 char *method; // The top half is built up by the web server and sent up to the
68 char *url; // application stack. The second half is built up by the application
69 char *http_version; // stack and sent back down to the web server, which transmits it to
70 char *site_prefix; // the client.
71 Array *request_headers;
73 long request_body_length;
75 char *response_string;
76 struct key_val_list *response_headers;
78 long response_body_length;
81 #define AUTH_MAX 256 // Maximum length of an HTTP AUTH header or equivalent cookie data
83 struct ctdlsession *next;
84 int is_bound; // Nonzero if this record is currently bound to a running thread
85 int sock; // Socket connection to Citadel server
86 char auth[AUTH_MAX]; // Auth string (empty if not logged in)
87 char whoami[64]; // Display name of currently logged in user (empty if not logged in)
88 char room[128]; // What room we are currently in
89 int room_current_view;
90 int room_default_view;
94 time_t last_access; // Timestamp of last request that used this session
95 time_t num_requests_handled;
98 extern char *ssl_cipher_list;
99 extern int is_https; // nonzero if we are an HTTPS server today
100 extern char *ctdlhost;
101 extern char *ctdlport;
103 void starttls(struct client_handle *);
104 void endtls(struct client_handle *);
105 int client_write_ssl(struct client_handle *ch, char *buf, int nbytes);
106 int client_read_ssl(struct client_handle *ch, char *buf, int nbytes);
114 #define TRACE syslog(LOG_DEBUG, "\033[3%dmCHECKPOINT: %s:%d\033[0m", ((__LINE__%6)+1), __FILE__, __LINE__)
115 #define SLEEPING 180 // TCP connection timeout
116 #define MAX_WORKER_THREADS 32 // Maximum number of worker threads permitted to exist
117 #define CTDL_CRYPTO_DIR "keys"
118 #define CTDL_KEY_PATH CTDL_CRYPTO_DIR "/webcit.key"
119 #define CTDL_CSR_PATH CTDL_CRYPTO_DIR "/webcit.csr"
120 #define CTDL_CER_PATH CTDL_CRYPTO_DIR "/webcit.cer"
121 #define SIGN_DAYS 3650 // how long our certificate should live
122 #define DEFAULT_SSL_CIPHER_LIST "DEFAULT" // See http://openssl.org/docs/apps/ciphers.html
123 #define WEBSERVER_PORT 80
124 #define WEBSERVER_INTERFACE "*"
125 #define CTDLHOST "dev.citadel.org"
126 #define CTDLPORT "504"
127 #define DEVELOPER_ID 0
129 #define TARGET "webcit01" /* Window target for inline URL's */
131 void worker_entry(int *pointer_to_master_socket);
132 void perform_one_http_transaction(struct client_handle *ch);
133 void add_response_header(struct http_transaction *h, char *key, char *val);
134 void perform_request(struct http_transaction *);
135 void do_404(struct http_transaction *);
136 void output_static(struct http_transaction *);
137 int uds_connectsock(char *sockpath);
138 int tcp_connectsock(char *host, char *service);
139 void ctdl_a(struct http_transaction *, struct ctdlsession *);
140 void ctdl_r(struct http_transaction *, struct ctdlsession *);
141 void ctdl_u(struct http_transaction *, struct ctdlsession *);
142 struct ctdlsession *connect_to_citadel(struct http_transaction *);
143 void disconnect_from_citadel(struct ctdlsession *);
144 char *header_val(struct http_transaction *h, char *requested_header);
145 int unescape_input(char *);
146 void http_redirect(struct http_transaction *h, char *to_where);
147 char *http_datestring(time_t xtime);
148 long *get_msglist(struct ctdlsession *c, char *which_msgs);
149 void caldav_report(struct http_transaction *h, struct ctdlsession *c);
150 long locate_message_by_uid(struct ctdlsession *c, char *uid);
151 void ctdl_delete_msgs(struct ctdlsession *c, long *msgnums, int num_msgs);
152 void dav_delete_message(struct http_transaction *h, struct ctdlsession *c, long msgnum);
153 void dav_get_message(struct http_transaction *h, struct ctdlsession *c, long msgnum);
154 void dav_put_message(struct http_transaction *h, struct ctdlsession *c, char *euid, long old_msgnum);
155 ssize_t ctdl_write(struct ctdlsession *ctdl, const void *buf, size_t count);
156 int login_to_citadel(struct ctdlsession *c, char *auth, char *resultbuf);
157 StrBuf *ctdl_readtextmsg(struct ctdlsession *ctdl);
158 StrBuf *html2html(const char *supplied_charset, int treat_as_wiki, char *roomname, long msgnum, StrBuf *Source);
159 void download_mime_component(struct http_transaction *h, struct ctdlsession *c, long msgnum, char *partnum);
160 StrBuf *text2html(const char *supplied_charset, int treat_as_wiki, char *roomname, long msgnum, StrBuf *Source);
161 StrBuf *variformat2html(StrBuf *Source);
162 int ctdl_readline(struct ctdlsession *ctdl, char *buf, int maxbytes);
163 int ctdl_read_binary(struct ctdlsession *ctdl, char *buf, int bytes_requested);
164 void ctdl_c(struct http_transaction *h, struct ctdlsession *c);
165 int webserver(char *webserver_interface, int webserver_port, int webserver_protocol);
166 void ctdl_printf(struct ctdlsession *ctdl, const char *format,...);
167 int webcit_tcp_server(const char *ip_addr, int port_number, int queue_len);
168 void do_502(struct http_transaction *h);
169 void do_404(struct http_transaction *h);
170 void do_412(struct http_transaction *h);
171 void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
172 void json_render_one_message(struct http_transaction *h, struct ctdlsession *c, long msgnum);