#include <XrdHttpExtHandler.hh>

Collaboration diagram for XrdHttpExtReq:

Public Member Functions
	XrdHttpExtReq (XrdHttpReq req, XrdHttpProtocol pr)

int	BuffgetData (int blen, char **data, bool wait)
	Get a pointer to data read from the client, valid for up to blen bytes from the buffer. Returns the validity. More...

int	ChunkResp (const char *body, long long bodylen)
	Send a (potentially partial) body in a chunked response; invoking with NULL body. More...

void	GetClientID (std::string &clid)

const XrdSecEntity &	GetSecEntity () const

int	SendData (const char *body, int bodylen)

int	SendSimpleResp (int code, const char desc, const char header_to_add, const char *body, long long bodylen)
	Sends a basic response. If the length is < 0 then it is calculated internally. More...

int	StartChunkedResp (int code, const char desc, const char header_to_add)
	Starts a chunked response; body of request is sent over multiple parts using the SendChunkResp. More...

int	StartSimpleResp (int code, const char desc, const char header_to_add, long long bodylen, bool keepalive)

Public Attributes
std::string	clientdn

std::string	clientgroups

std::string	clienthost

std::map< std::string, std::string > &	headers

long long	length

std::map< std::string, std::string >	mReprDigest
	Repr-Digest map where the key is the digest name and the value is the base64 encoded digest value. More...

int	mSciTag

std::map< std::string, uint8_t >	mWantReprDigest
	Want-Repr-Digest map where the key is the digest name and the value is the weighted preference. More...

XrdNetPMark *	pmark

std::string	resource

bool	tpcForwardCreds = false

std::string	verb

Detailed Description

Definition at line 48 of file XrdHttpExtHandler.hh.

Constructor & Destructor Documentation

◆ XrdHttpExtReq()

XrdHttpExtReq::XrdHttpExtReq	(	XrdHttpReq *	req,
		XrdHttpProtocol *	pr
	)

Definition at line 86 of file XrdHttpExtHandler.cc.

                                                                 : prot(pr),
 verb(req->requestverb), headers(req->allheaders) {
   // Here we fill the request summary with all the fields we can
   resource = req->resource.c_str();
   int envlen = 0;
   
   const char *p = nullptr;
   if (req->opaque)
     p = req->opaque->Env(envlen);
   headers["xrd-http-query"] = p ? p:"";
   p = req->resourceplusopaque.c_str();
   headers["xrd-http-fullresource"] = p ? p:"";
   headers["xrd-http-prot"] = prot->isHTTPS()?"https":"http";
   
   // These fields usually identify the client that connected
  
   
   if (prot->SecEntity.moninfo) {
     clientdn = prot->SecEntity.moninfo;
     trim(clientdn);
   }
   if (prot->SecEntity.host) {
     clienthost = prot->SecEntity.host;
     trim(clienthost);
   }
   if (prot->SecEntity.vorg) {
     clientgroups = prot->SecEntity.vorg;
     trim(clientgroups);
   }
  
   // Get the packet marking handle and the client scitag from the XrdHttp layer
   pmark = prot->pmarkHandle;
   mSciTag = req->mScitag;
   mReprDigest = req->m_repr_digest;
   mWantReprDigest = req->m_want_repr_digest;
   tpcForwardCreds = prot->tpcForwardCreds;
  
   length = req->length;
 }

References XrdOucString::c_str(), clientdn, clientgroups, clienthost, XrdOucEnv::Env(), headers, XrdSecEntity::host, XrdHttpProtocol::isHTTPS(), length, XrdHttpReq::length, XrdHttpReq::m_repr_digest, XrdHttpReq::m_want_repr_digest, XrdSecEntity::moninfo, mReprDigest, mSciTag, XrdHttpReq::mScitag, mWantReprDigest, XrdHttpReq::opaque, pmark, XrdHttpProtocol::pmarkHandle, resource, XrdHttpReq::resource, XrdHttpReq::resourceplusopaque, XrdHttpProtocol::SecEntity, tpcForwardCreds, XrdHttpProtocol::tpcForwardCreds, trim(), and XrdSecEntity::vorg.

Here is the call graph for this function:

Member Function Documentation

◆ BuffgetData()

int XrdHttpExtReq::BuffgetData	(	int	blen,
		char **	data,
		bool	wait
	)

Get a pointer to data read from the client, valid for up to blen bytes from the buffer. Returns the validity.

Definition at line 65 of file XrdHttpExtHandler.cc.

                                                                {
  
   if (!prot) return -1;
   int nb = prot->BuffgetData(blen, data, wait);
   
   return nb;
 }

Referenced by Macaroons::Handler::ProcessReq().

Here is the caller graph for this function:

◆ ChunkResp()

int XrdHttpExtReq::ChunkResp	(	const char *	body,
		long long	bodylen
	)

Send a (potentially partial) body in a chunked response; invoking with NULL body.

Definition at line 58 of file XrdHttpExtHandler.cc.

 {
   if (!prot) return -1;
  
   return prot->ChunkResp(body, bodylen);
 }

◆ GetClientID()

void XrdHttpExtReq::GetClientID ( std::string & clid )

Definition at line 73 of file XrdHttpExtHandler.cc.

 {
    char buff[512];
    prot->Link->Client(buff, sizeof(buff));
    clid = buff;
 }

References XrdLink::Client(), and XrdHttpProtocol::Link.

Here is the call graph for this function:

◆ GetSecEntity()

const XrdSecEntity & XrdHttpExtReq::GetSecEntity ( ) const

Definition at line 80 of file XrdHttpExtHandler.cc.

 {
   return prot->SecEntity;
 }

References XrdHttpProtocol::SecEntity.

◆ SendData()

int XrdHttpExtReq::SendData	(	const char *	body,
		int	bodylen
	)

Definition at line 44 of file XrdHttpExtHandler.cc.

 {
   if (!prot) return -1;
  
   return prot->SendData(body, bodylen);
 }

◆ SendSimpleResp()

int XrdHttpExtReq::SendSimpleResp	(	int	code,
		const char *	desc,
		const char *	header_to_add,
		const char *	body,
		long long	bodylen
	)

Sends a basic response. If the length is < 0 then it is calculated internally.

Definition at line 30 of file XrdHttpExtHandler.cc.

 {
   if (!prot) return -1;
  
   return prot->SendSimpleResp(code, desc, header_to_add, body, bodylen, true);
 }

Referenced by TPC::TPCHandler::ProcessReq(), and Macaroons::Handler::ProcessReq().

Here is the caller graph for this function:

◆ StartChunkedResp()

int XrdHttpExtReq::StartChunkedResp	(	int	code,
		const char *	desc,
		const char *	header_to_add
	)

Starts a chunked response; body of request is sent over multiple parts using the SendChunkResp.

Definition at line 51 of file XrdHttpExtHandler.cc.

 {
   if (!prot) return -1;
  
   return prot->StartChunkedResp(code, desc, header_to_add, -1, true);
 }

◆ StartSimpleResp()

int XrdHttpExtReq::StartSimpleResp	(	int	code,
		const char *	desc,
		const char *	header_to_add,
		long long	bodylen,
		bool	keepalive
	)

Definition at line 37 of file XrdHttpExtHandler.cc.

 {
   if (!prot) return -1;
  
   return prot->StartSimpleResp(code, desc, header_to_add, bodylen, true);
 }

Member Data Documentation

◆ clientdn

std::string XrdHttpExtReq::clientdn

Definition at line 58 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ clientgroups

std::string XrdHttpExtReq::clientgroups

Definition at line 58 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ clienthost

std::string XrdHttpExtReq::clienthost

Definition at line 58 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ headers

std::map<std::string, std::string>& XrdHttpExtReq::headers

Definition at line 56 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq(), TPC::TPCHandler::ProcessReq(), Macaroons::Handler::ProcessReq(), TPC::State::SetupHeaders(), and TPC::State::SetupHeadersForHEAD().

◆ length

long long XrdHttpExtReq::length

Definition at line 59 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ mReprDigest

std::map<std::string,std::string> XrdHttpExtReq::mReprDigest

Repr-Digest map where the key is the digest name and the value is the base64 encoded digest value.

Definition at line 68 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq(), TPC::State::SetupHeaders(), and TPC::State::SetupHeadersForHEAD().

◆ mSciTag

int XrdHttpExtReq::mSciTag

Definition at line 65 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq(), XrdHttpTpc::PMarkManager::beginPMarks(), and XrdHttpTpc::PMarkManager::isEnabled().

◆ mWantReprDigest

std::map<std::string, uint8_t> XrdHttpExtReq::mWantReprDigest

Want-Repr-Digest map where the key is the digest name and the value is the weighted preference.

Definition at line 70 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ pmark

XrdNetPMark* XrdHttpExtReq::pmark

Definition at line 61 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ resource

std::string XrdHttpExtReq::resource

Definition at line 55 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq(), XrdHttpTpc::PMarkManager::beginPMarks(), and Macaroons::Handler::ProcessReq().

◆ tpcForwardCreds

bool XrdHttpExtReq::tpcForwardCreds = false

Definition at line 63 of file XrdHttpExtHandler.hh.

Referenced by XrdHttpExtReq().

◆ verb

std::string XrdHttpExtReq::verb

Definition at line 55 of file XrdHttpExtHandler.hh.

Referenced by TPC::TPCHandler::ProcessReq().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XrdHttpExtReq()

Member Function Documentation

◆ BuffgetData()

◆ ChunkResp()

◆ GetClientID()

◆ GetSecEntity()

◆ SendData()

◆ SendSimpleResp()

◆ StartChunkedResp()

◆ StartSimpleResp()

Member Data Documentation

◆ clientdn

◆ clientgroups

◆ clienthost

◆ headers

◆ length

◆ mReprDigest

◆ mSciTag

◆ mWantReprDigest

◆ pmark

◆ resource

◆ tpcForwardCreds

◆ verb