xrootd
XrdHttpProtocol.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of XrdHTTP: A pragmatic implementation of the
3 // HTTP/WebDAV protocol for the Xrootd framework
4 //
5 // Copyright (c) 2013 by European Organization for Nuclear Research (CERN)
6 // Author: Fabrizio Furano <furano@cern.ch>
7 // File Date: Nov 2012
8 //------------------------------------------------------------------------------
9 // XRootD is free software: you can redistribute it and/or modify
10 // it under the terms of the GNU Lesser General Public License as published by
11 // the Free Software Foundation, either version 3 of the License, or
12 // (at your option) any later version.
13 //
14 // XRootD is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public License
20 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
21 //------------------------------------------------------------------------------
22 
23 
24 #ifndef __XRDHTTP_PROTOCOL_H__
25 #define __XRDHTTP_PROTOCOL_H__
26 
37 #include <stdlib.h>
38 #include <unistd.h>
39 #include <sys/types.h>
40 
41 #include "XrdSys/XrdSysError.hh"
42 #include "XrdSys/XrdSysPthread.hh"
44 #include "Xrd/XrdObject.hh"
46 #include "XrdOuc/XrdOucStream.hh"
47 #include "Xrd/XrdProtocol.hh"
48 #include "XrdOuc/XrdOucHash.hh"
49 
50 #include <openssl/ssl.h>
51 
52 #include <vector>
53 
54 #include "XrdHttpReq.hh"
55 
56 /******************************************************************************/
57 /* D e f i n e s */
58 /******************************************************************************/
59 
60 
61 #ifndef __GNUC__
62 #define __attribute__(x)
63 #endif
64 
65 class XrdOucTokenizer;
66 class XrdOucTrace;
67 class XrdBuffer;
68 class XrdLink;
69 class XrdXrootdProtocol;
70 class XrdHttpSecXtractor;
71 class XrdHttpExtHandler;
72 struct XrdVersionInfo;
73 class XrdOucGMap;
74 class XrdCryptoFactory;
75 
76 class XrdHttpProtocol : public XrdProtocol {
77 
78  friend class XrdHttpReq;
79  friend class XrdHttpExtReq;
80 
81 public:
82 
84  static int Configure(char *parms, XrdProtocol_Config *pi);
85 
87  void DoIt() {
88  if (Resume) (*this.*Resume)();
89  }
90 
93 
95  int Process(XrdLink *lp); // Sync: Job->Link.DoIt->Process
96 
97 
99  void Recycle(XrdLink *lp, int consec, const char *reason);
100 
102  int Stats(char *buff, int blen, int do_sync = 0);
103 
104 
105 
106 
108  int doStat(char *fname);
109 
111  int doChksum(const XrdOucString &fname);
112 
114  XrdHttpProtocol(const XrdHttpProtocol&) = default;
116  XrdHttpProtocol(bool imhttps);
118  Cleanup();
119  }
120 
123 
124 
127 
129  bool isHTTPS() { return ishttps; }
130 
131 private:
132 
133 
136 
138  static bool InitTLS();
139 
141  static bool InitSecurity();
142 
144  int StartSimpleResp(int code, const char *desc, const char *header_to_add, long long bodylen, bool keepalive);
145 
147  int SendData(const char *body, int bodylen);
148 
150  void Cleanup();
151 
153  void Reset();
154 
157  int HandleAuthentication(XrdLink* lp);
158 
161  int GetVOMSData(XrdLink *lp);
162 
163  // Handle gridmap file mapping if present
164  //
165  // @return 0 if successful, otherwise !0
166  int HandleGridMap(XrdLink* lp);
167 
170  int getDataOneShot(int blen, bool wait=false);
171 
173  static BIO *CreateBIO(XrdLink *lp);
174 
176  static int Config(const char *fn, XrdOucEnv *myEnv);
177  static const char *Configed();
178  static int xtrace(XrdOucStream &Config);
179  static int xsslcert(XrdOucStream &Config);
180  static int xsslkey(XrdOucStream &Config);
181  static int xsecxtractor(XrdOucStream &Config);
182  static int xexthandler(XrdOucStream & Config, const char *ConfigFN, XrdOucEnv *myEnv);
183  static int xsslcadir(XrdOucStream &Config);
184  static int xsslcipherfilter(XrdOucStream &Config);
185  static int xdesthttps(XrdOucStream &Config);
186  static int xlistdeny(XrdOucStream &Config);
187  static int xlistredir(XrdOucStream &Config);
188  static int xselfhttps2http(XrdOucStream &Config);
189  static int xembeddedstatic(XrdOucStream &Config);
190  static int xstaticredir(XrdOucStream &Config);
191  static int xstaticpreload(XrdOucStream &Config);
192  static int xgmap(XrdOucStream &Config);
193  static int xsslcafile(XrdOucStream &Config);
194  static int xsslverifydepth(XrdOucStream &Config);
195  static int xsecretkey(XrdOucStream &Config);
196  static int xheader2cgi(XrdOucStream &Config);
197  static int xhttpsmode(XrdOucStream &Config);
198  static int xtlsreuse(XrdOucStream &Config);
199 
200  static bool isRequiredXtractor; // If true treat secxtractor errors as fatal
202 
203  // Loads the SecXtractor plugin, if available
204  static int LoadSecXtractor(XrdSysError *eDest, const char *libName,
205  const char *libParms);
206 
207  // An oldstyle struct array to hold exthandlers
208  #define MAX_XRDHTTPEXTHANDLERS 4
209  static struct XrdHttpExtHandlerInfo {
210  char name[16];
213  static int exthandlercnt;
214 
215  // Loads the ExtHandler plugin, if available
216  static int LoadExtHandler(XrdSysError *eDest, const char *libName,
217  const char *configFN, const char *libParms,
218  XrdOucEnv *myEnv, const char *instName);
219 
220  // Determines whether one of the loaded ExtHandlers are interested in
221  // handling a given request.
222  //
223  // Returns NULL if there is no matching handler.
225 
226  // Tells if an ext handler with the given name has already been loaded
227  static bool ExtHandlerLoaded(const char *handlername);
228 
233 
236 
238  int BuffAvailable();
240  int BuffUsed();
242  int BuffFree();
243 
245  void BuffConsume(int blen);
247  int BuffgetData(int blen, char **data, bool wait);
249  int BuffgetLine(XrdOucString &dest);
250 
252  int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen, bool keepalive);
253 
255  // API.
256  int StartChunkedResp(int code, const char *desc, const char *header_to_add, bool keepalive);
257 
259  // indicates that this is the last chunk in the response.
260  int ChunkResp(const char *body, long long bodylen);
261 
263  char *GetClientIPStr();
264 
267 
270 
272  SSL *ssl;
273 
275  BIO *sbio;
276 
278  static BIO *sslbio_err;
279 
281  bool ishttps;
282 
285  bool ssldone;
287 
288 protected:
289 
290  // Statistical area
291  //
292 // static XrdXrootdStats *SI;
293 // int numReads; // Count for kXR_read
294 // int numReadP; // Count for kXR_read pre-preads
295 // int numReadV; // Count for kR_readv
296 // int numSegsV; // Count for kR_readv segmens
297 // int numWrites; // Count
298 // int numFiles; // Count
299 //
300 // int cumReads; // Count less numReads
301 // int cumReadP; // Count less numReadP
302 // int cumReadV; // Count less numReadV
303 // int cumSegsV; // Count less numSegsV
304 // int cumWrites; // Count less numWrites
305 // long long totReadP; // Bytes
306 
307  static XrdScheduler *Sched; // System scheduler
308  static XrdBuffManager *BPool; // Buffer manager
309  static XrdSysError eDest; // Error message handler
310  static XrdSecService *CIA; // Authentication Server
311 
314 
317  char *Addr_str;
318 
320  static XrdOucGMap *servGMap; // Grid mapping service
321 
324 
325 
329 
330 
331  //
332  // Processing configuration values
333  //
334 
336  static int hailWait;
337 
339  static int readWait;
340 
342  static int Port;
343 
345  static char * Port_str;
346 
349 
351  static char *gridmap;// [s] gridmap file [/etc/grid-security/gridmap]
352  static bool isRequiredGridmap; // If true treat gridmap errors as fatal
353 
355  static char *secretkey;
356 
358  static int sslverifydepth;
359 
361  static bool isdesthttps;
362 
364  static char *listredir;
365 
367  static bool listdeny;
368 
370  static bool selfhttps2http;
371 
373  static bool embeddedstatic;
374 
375  // Url to redirect to in the case a /static is requested
376  static char *staticredir;
377 
378  // Hash that keeps preloaded files
380  char *data;
381  int len;
382  };
384 
387 
389  static std::map< std::string, std::string > hdr2cgimap;
390 
392  static int m_bio_type;
393 
395  static BIO_METHOD *m_bio_method;
396 };
397 #endif
static char * secretkey
The key used to calculate the url hashes.
Definition: XrdHttpProtocol.hh:355
static XrdObjectQ< XrdHttpProtocol > ProtStack
Definition: XrdHttpProtocol.hh:121
static int xgmap(XrdOucStream &Config)
char * Addr_str
Definition: XrdHttpProtocol.hh:317
static BIO * CreateBIO(XrdLink *lp)
Create a new BIO object from an XrdLink. Returns NULL on failure.
static char * sslcafile
Definition: XrdHttpProtocol.hh:348
static int exthandlercnt
Definition: XrdHttpProtocol.hh:213
void Cleanup()
Deallocate resources, in order to reutilize an object of this class.
static bool isdesthttps
True if the redirections must be towards https targets.
Definition: XrdHttpProtocol.hh:361
static char * Port_str
Our port, as a string.
Definition: XrdHttpProtocol.hh:345
static int xheader2cgi(XrdOucStream &Config)
int(XrdHttpProtocol::* Resume)()
The resume function.
Definition: XrdHttpProtocol.hh:135
static kXR_int32 myRole
Our role.
Definition: XrdHttpProtocol.hh:386
static int xsecxtractor(XrdOucStream &Config)
static int readWait
Timeout for reading data.
Definition: XrdHttpProtocol.hh:339
static XrdHttpExtHandler * FindMatchingExtHandler(const XrdHttpReq &)
static char * sslcadir
Definition: XrdHttpProtocol.hh:348
char * GetClientIPStr()
Gets a string that represents the IP address of the client. Must be freed.
XrdSecEntity SecEntity
Authentication area.
Definition: XrdHttpProtocol.hh:126
static int Config(const char *fn, XrdOucEnv *myEnv)
Functions related to the configuration.
char * myBuffEnd
Definition: XrdHttpProtocol.hh:232
static int xsecretkey(XrdOucStream &Config)
static int xsslkey(XrdOucStream &Config)
Definition: XrdSecInterface.hh:551
int len
Definition: XrdHttpProtocol.hh:381
void BuffConsume(int blen)
Consume some bytes from the buffer.
Definition: XrdHttpReq.hh:77
XrdHttpReq CurrentReq
Definition: XrdHttpProtocol.hh:328
static int xlistredir(XrdOucStream &Config)
int doStat(char *fname)
Perform a Stat request.
XrdHttpProtocol(const XrdHttpProtocol &)=default
Ctor, dtors and copy ctor.
static char * sslcipherfilter
Definition: XrdHttpProtocol.hh:348
static char * gridmap
Gridmap file location. The same used by XrdSecGsi.
Definition: XrdHttpProtocol.hh:351
int getDataOneShot(int blen, bool wait=false)
static int xstaticredir(XrdOucStream &Config)
Definition: XrdOucStream.hh:46
Definition: XrdHttpProtocol.hh:209
Definition: XrdXrootdBridge.hh:61
static int xhttpsmode(XrdOucStream &Config)
static bool listdeny
If true, any form of listing is denied.
Definition: XrdHttpProtocol.hh:367
XrdBuffer * myBuff
Circular Buffer used to read the request.
Definition: XrdHttpProtocol.hh:230
int ChunkResp(const char *body, long long bodylen)
Send a (potentially partial) body in a chunked response; invoking with NULL body. ...
bool isHTTPS()
called via https
Definition: XrdHttpProtocol.hh:129
static int xstaticpreload(XrdOucStream &Config)
static bool InitTLS()
Initialization of the ssl security things.
XrdObject< XrdHttpProtocol > ProtLink
Definition: XrdHttpProtocol.hh:122
Definition: XrdProtocol.hh:124
static XrdHttpSecXtractor * secxtractor
Definition: XrdHttpProtocol.hh:201
char * myBuffStart
The circular pointers.
Definition: XrdHttpProtocol.hh:232
static bool ExtHandlerLoaded(const char *handlername)
Definition: XrdXrootdProtocol.hh:95
static bool isRequiredXtractor
Definition: XrdHttpProtocol.hh:200
static XrdOucHash< StaticPreloadInfo > * staticpreload
Definition: XrdHttpProtocol.hh:383
static const char * Configed()
static bool isRequiredGridmap
Definition: XrdHttpProtocol.hh:352
Definition: XrdBuffer.hh:71
static BIO * sslbio_err
bio to print SSL errors
Definition: XrdHttpProtocol.hh:278
static XrdSecService * CIA
Definition: XrdHttpProtocol.hh:310
static int Configure(char *parms, XrdProtocol_Config *pi)
Read and apply the configuration.
Definition: XrdOucTrace.hh:35
Definition: XrdSysError.hh:89
int BuffUsed()
How many bytes in the buffer.
char * data
Definition: XrdHttpProtocol.hh:380
XrdHttpExtHandler * ptr
Definition: XrdHttpProtocol.hh:211
int BuffgetData(int blen, char **data, bool wait)
Get a pointer, valid for up to blen bytes from the buffer. Returns the validity.
BIO * sbio
Private SSL bio.
Definition: XrdHttpProtocol.hh:275
int BuffAvailable()
How many bytes still fit into the buffer in a contiguous way.
int doChksum(const XrdOucString &fname)
Perform a checksum request.
Definition: XrdScheduler.hh:44
static int Port
Our port.
Definition: XrdHttpProtocol.hh:342
static int xexthandler(XrdOucStream &Config, const char *ConfigFN, XrdOucEnv *myEnv)
static int sslverifydepth
Depth of verification of a certificate chain.
Definition: XrdHttpProtocol.hh:358
int SendData(const char *body, int bodylen)
Send some generic data to the client.
static int xsslcadir(XrdOucStream &Config)
static int xselfhttps2http(XrdOucStream &Config)
static XrdScheduler * Sched
Definition: XrdHttpProtocol.hh:307
int HandleGridMap(XrdLink *lp)
static int xsslverifydepth(XrdOucStream &Config)
int GetVOMSData(XrdLink *lp)
char name[16]
Definition: XrdHttpProtocol.hh:210
static int LoadSecXtractor(XrdSysError *eDest, const char *libName, const char *libParms)
XrdXrootd::Bridge * Bridge
The Bridge that we use to exercise the xrootd internals.
Definition: XrdHttpProtocol.hh:323
static bool selfhttps2http
If client is HTTPS, self-redirect with HTTP+token.
Definition: XrdHttpProtocol.hh:370
XrdProtocol * Match(XrdLink *lp)
Tells if the oustanding bytes on the socket match this protocol implementation.
Definition: XrdOucGMap.hh:48
~XrdHttpProtocol()
Definition: XrdHttpProtocol.hh:117
static int xlistdeny(XrdOucStream &Config)
static XrdBuffManager * BPool
Definition: XrdHttpProtocol.hh:308
Definition: XrdProtocol.hh:55
Definition: XrdOucEnv.hh:41
#define MAX_XRDHTTPEXTHANDLERS
Definition: XrdHttpProtocol.hh:208
int HandleAuthentication(XrdLink *lp)
void DoIt()
Override from the base class.
Definition: XrdHttpProtocol.hh:87
static XrdOucGMap * servGMap
The instance of the DN mapper. Created only when a valid path is given.
Definition: XrdHttpProtocol.hh:320
XrdLink * Link
The link we are bound to.
Definition: XrdHttpProtocol.hh:313
Definition: XrdHttpExtHandler.hh:79
static int xsslcipherfilter(XrdOucStream &Config)
void Reset()
Reset values, counters, in order to reutilize an object of this class.
static int hailWait
Timeout for reading the handshake.
Definition: XrdHttpProtocol.hh:336
bool ishttps
Tells if the client is https.
Definition: XrdHttpProtocol.hh:281
static std::map< std::string, std::string > hdr2cgimap
Rules that turn HTTP headers to cgi tokens in the URL, for internal comsumption.
Definition: XrdHttpProtocol.hh:389
static XrdSysError eDest
Definition: XrdHttpProtocol.hh:309
static int m_bio_type
Type identifier for our custom BIO objects.
Definition: XrdHttpProtocol.hh:392
Definition: XrdHttpProtocol.hh:76
static char * sslcert
OpenSSL stuff.
Definition: XrdHttpProtocol.hh:348
int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen, bool keepalive)
Sends a basic response. If the length is < 0 then it is calculated internally.
static bool InitSecurity()
Initialization fo security addon.
XrdOucString tmpline
A nice var to hold the current header line.
Definition: XrdHttpProtocol.hh:235
static BIO_METHOD * m_bio_method
C-style vptr table for our custom BIO objects.
Definition: XrdHttpProtocol.hh:395
int StartChunkedResp(int code, const char *desc, const char *header_to_add, bool keepalive)
Starts a chunked response; body of request is sent over multiple parts using the SendChunkResp.
static XrdCryptoFactory * myCryptoFactory
Definition: XrdHttpProtocol.hh:286
long ResumeBytes
Tells that we are just waiting to have N bytes in the buffer.
Definition: XrdHttpProtocol.hh:269
Definition: XrdHttpSecXtractor.hh:41
SSL * ssl
Private SSL context.
Definition: XrdHttpProtocol.hh:272
int Stats(char *buff, int blen, int do_sync=0)
Get activity stats.
static char * listredir
Url to redirect to in the case a listing is requested.
Definition: XrdHttpProtocol.hh:364
static int LoadExtHandler(XrdSysError *eDest, const char *libName, const char *configFN, const char *libParms, XrdOucEnv *myEnv, const char *instName)
Definition: XrdOucHash.hh:127
int StartSimpleResp(int code, const char *desc, const char *header_to_add, long long bodylen, bool keepalive)
Start a response back to the client.
static char * staticredir
Definition: XrdHttpProtocol.hh:376
int kXR_int32
Definition: XPtypes.hh:89
Definition: XrdOucTokenizer.hh:32
Definition: XrdCryptoFactory.hh:121
int BuffFree()
How many bytes free in the buffer.
static bool embeddedstatic
If true, use the embedded css and icons.
Definition: XrdHttpProtocol.hh:373
Definition: XrdSecEntity.hh:63
static int xembeddedstatic(XrdOucStream &Config)
static int xtrace(XrdOucStream &Config)
Main request/response class, handling the logical status of the communication.
static char * sslkey
Definition: XrdHttpProtocol.hh:348
bool DoingLogin
Tells that we are just logging in.
Definition: XrdHttpProtocol.hh:266
int Process(XrdLink *lp)
Process data incoming from the socket.
Definition: XrdHttpExtHandler.hh:45
bool ssldone
Definition: XrdHttpProtocol.hh:285
static int xsslcafile(XrdOucStream &Config)
Definition: XrdHttpProtocol.hh:379
int BuffgetLine(XrdOucString &dest)
Copy a full line of text from the buffer into dest. Zero if no line can be found in the buffer...
Definition: XrdOucString.hh:254
void Recycle(XrdLink *lp, int consec, const char *reason)
Recycle this instance.
Definition: XrdBuffer.hh:41
static int xsslcert(XrdOucStream &Config)
static int xtlsreuse(XrdOucStream &Config)
static struct XrdHttpProtocol::XrdHttpExtHandlerInfo exthandler[MAX_XRDHTTPEXTHANDLERS]
static int xdesthttps(XrdOucStream &Config)
XrdHttpProtocol operator=(const XrdHttpProtocol &rhs)