XrdHttpExtHandler.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of XrdHTTP: A pragmatic implementation of the
// HTTP/WebDAV protocol for the Xrootd framework
//
// Copyright (c) 2017 by European Organization for Nuclear Research (CERN)
// Author: Fabrizio Furano <furano@cern.ch>
// File Date: May 2017
//------------------------------------------------------------------------------
// XRootD 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, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
 
 
 
 
 
 
 
 
 
 
#ifndef __XRDHTTPEXTHANDLER_H__
#define __XRDHTTPEXTHANDLER_H__
 
#include <map>
#include <string>
#include <cstdint>
 
#include "XrdNet/XrdNetPMark.hh"
 
class XrdLink;
class XrdSecEntity;
class XrdHttpReq;
class XrdHttpProtocol;
 
// This class summarizes the content of a request, for consumption by an external plugin
class XrdHttpExtReq {
private:
  XrdHttpProtocol *prot;
  
public:
  XrdHttpExtReq(XrdHttpReq *req, XrdHttpProtocol *pr);
  
  std::string verb, resource;
  std::map<std::string, std::string> &headers;
  
  std::string clientdn, clienthost, clientgroups;
  long long length;
 
  XrdNetPMark * pmark;
 
  bool tpcForwardCreds = false;
 
  int mSciTag;

  std::map<std::string,std::string> mReprDigest;
  std::map<std::string, uint8_t> mWantReprDigest;
  // Get full client identifier
  void GetClientID(std::string &clid);
  
  // A view of the XrdSecEntity associated with the request.
  const XrdSecEntity &GetSecEntity() const;

  int BuffgetData(int blen, char **data, bool wait);

  int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen);
 
  // Start response to the client; often followed by data in multiple chunks
  int StartSimpleResp(int code, const char *desc, const char *header_to_add, long long bodylen, bool keepalive);
 
  // Send generic data to the client
  int SendData(const char *body, int bodylen);

  //  API.
  int StartChunkedResp(int code, const char *desc, const char *header_to_add);

  //  indicates that this is the last chunk in the response.
  int ChunkResp(const char *body, long long bodylen);
};
 

class XrdHttpExtHandler {
  
public:
  
  // e.g. applying a prefix matching scheme or whatever
  virtual bool MatchesPath(const char *verb, const char *path) = 0;
  
  virtual int ProcessReq(XrdHttpExtReq &) = 0;
  
  virtual int Init(const char *cfgfile) = 0;
  
  //------------------------------------------------------------------------------
  //------------------------------------------------------------------------------
  
  XrdHttpExtHandler() {}
  
  //------------------------------------------------------------------------------
  //------------------------------------------------------------------------------
  
  virtual     ~XrdHttpExtHandler() {}
};
 
/******************************************************************************/
/*                    X r d H t t p G e t E x t H a n d l e   r               */
/******************************************************************************/
 
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
 
class XrdSysError;
class XrdOucEnv;
 
#define XrdHttpExtHandlerArgs XrdSysError       *eDest, \
                              const char        *confg, \
                              const char        *parms, \
                              XrdOucEnv         *myEnv
 
extern "C" XrdHttpExtHandler *XrdHttpGetExtHandler(XrdHttpExtHandlerArgs);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#endif