XrdHttpCorsHandler Class Reference

#include <XrdHttpCorsHandler.hh>

Inheritance diagram for XrdHttpCorsHandler:

Collaboration diagram for XrdHttpCorsHandler:

Public Member Functions
	XrdHttpCorsHandler ()=default
void	addAllowedOrigin (const std::string &origin) override
int	Configure (const char *configFN, XrdSysError *errP) override
std::optional< std::string >	getCORSAllowOriginHeader (const std::string &origin) override

Detailed Description

Basic CORS plugin implementation

Definition at line 31 of file XrdHttpCorsHandler.hh.

Constructor & Destructor Documentation

XrdHttpCorsHandler()

XrdHttpCorsHandler::XrdHttpCorsHandler ( )

default

Member Function Documentation

addAllowedOrigin()

void XrdHttpCorsHandler::addAllowedOrigin ( const std::string & origin )

overridevirtual

Add trusted origins to the CORS plugin

Parameters

origin

the trusted origin to add

Implements XrdHttpCors.

Definition at line 64 of file XrdHttpCorsHandler.cc.

                                                                  {
  std::string_view origin_sv(origin);
  XrdOucUtils::trim(origin_sv);
  if(!origin_sv.empty()) {
    m_origins.emplace(origin_sv);
  }
}

References XrdOucUtils::trim().

Referenced by Configure().

Here is the call graph for this function:

Here is the caller graph for this function:

Configure()

int XrdHttpCorsHandler::Configure ( const char * configFN, XrdSysError * errP )

overridevirtual

Configure the CORS handler

Parameters

configFN	the configuration file name
errP	the error pointer allowing to log potential errors

Returns

0 if successful, 1 otherwise

Implements XrdHttpCors.

Definition at line 40 of file XrdHttpCorsHandler.cc.

                                                                         {
  // Get the cors.origin parameters which can be either space-delimited or a repetition of cors.origin
  XrdOucGatherConf gconf("cors.origin",errP);
  if(gconf.Gather(configFN,XrdOucGatherConf::only_body) < 0){
    return 1;
  }
  if(gconf.GetLine()) {
    while(char * val = gconf.GetToken()) {
      // No need to check for correctness
      addAllowedOrigin(val);
    }
  }
  return 0;
}

References addAllowedOrigin(), XrdOucGatherConf::Gather(), XrdOucGatherConf::GetLine(), XrdOucGatherConf::GetToken(), and XrdOucGatherConf::only_body.

Here is the call graph for this function:

getCORSAllowOriginHeader()

std::optional< std::string > XrdHttpCorsHandler::getCORSAllowOriginHeader ( const std::string & origin )

overridevirtual

Returns the fully formed Access-Control-Allow-Origin header. If the origin passed in parameter matches one of the previously added origins, it will return "Access-Control-Allow-Origin: matchedOrigin". If the origin passed in parameter does not match any of the previously added origins, then std::nullopt will be returned

Parameters

origin

Returns

either the fully formed Access-Control-Allow-Origin header or nullopt if the origin does not match any added origin

Implements XrdHttpCors.

Definition at line 55 of file XrdHttpCorsHandler.cc.

                                                                                            {
  auto originItor = m_origins.find(origin);
  if(originItor != m_origins.end()) {
    return "Access-Control-Allow-Origin: " + origin;
  }
  // We did not find any allowed origin, return nullopt
  return std::nullopt;
}

---

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

• XrdHttpCorsHandler.hh
• XrdHttpCorsHandler.cc