XRootD
XrdNetPMark.hh
Go to the documentation of this file.
1 #ifndef __XRDNETPMARK__
2 #define __XRDNETPMARK__
3 /******************************************************************************/
4 /* */
5 /* X r d N e t P M a r k . h h */
6 /* */
7 /* (c) 2021 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <cstring>
34 
35 class XrdNetAddrInfo;
36 class XrdSecEntity;
37 
39 {
40 public:
41 
42 class Handle
43  {public:
44 
45  bool getEA(int &ec, int &ac)
46  {if (Valid()) {ec = eCode; ac = aCode; return true;}
47  ec = ac = 0; return false;
48  }
49  // According to the specifications, ExpID and actID can be equal to 0 for HTTP-TPC.
50  bool Valid() {return (eCode == 0 && aCode == 0) || (eCode >= minExpID && eCode <= maxExpID && aCode >= minActID && aCode <= maxActID);}
51 
52  Handle(const char *app=0, int ecode=0, int acode=0)
53  : appName(app), eCode(ecode), aCode(acode) {}
54 
56  : appName(h.appName), eCode(h.eCode), aCode(h.aCode) {};
57 
58  virtual ~Handle() {};
59 
60  protected:
61  const char *appName;
62  int eCode;
63  int aCode;
64  };
65 
66 virtual Handle *Begin(XrdSecEntity &Client, const char *path=0,
67  const char *cgi=0,
68  const char *app=0) = 0;
69 
70 virtual Handle *Begin(XrdNetAddrInfo &addr, Handle &handle,
71  const char *tident) = 0;
72 
73 static bool getEA(const char *cgi, int &ecode, int &acode);
74 
76 virtual ~XrdNetPMark() {} // This object cannot be deleted!
77 
78 // ID limits and specifications
79 //
83 static const int minTotID = 65;
84 static const int maxTotID = 65535;
85 
86 protected:
87 
88 static const int btsActID = 6;
89 static const int mskActID = 63;
90 static const int minExpID = minTotID >> btsActID;
91 static const int minActID = minTotID & mskActID;
92 static const int maxExpID = maxTotID >> btsActID;
93 static const int maxActID = maxTotID & mskActID;
94 
95 };
96 #endif
#define tident
const char * appName
Definition: XrdNetPMark.hh:58
bool getEA(int &ec, int &ac)
Definition: XrdNetPMark.hh:45
Handle(const char *app=0, int ecode=0, int acode=0)
Definition: XrdNetPMark.hh:52
static const int minTotID
Definition: XrdNetPMark.hh:83
static bool getEA(const char *cgi, int &ecode, int &acode)
Definition: XrdNetPMark.cc:40
static const int btsActID
Definition: XrdNetPMark.hh:88
static const int maxExpID
Definition: XrdNetPMark.hh:92
static const int minActID
Definition: XrdNetPMark.hh:91
virtual ~XrdNetPMark()
Definition: XrdNetPMark.hh:76
virtual Handle * Begin(XrdNetAddrInfo &addr, Handle &handle, const char *tident)=0
static const int maxActID
Definition: XrdNetPMark.hh:93
virtual Handle * Begin(XrdSecEntity &Client, const char *path=0, const char *cgi=0, const char *app=0)=0
static const int maxTotID
Definition: XrdNetPMark.hh:84
static const int mskActID
Definition: XrdNetPMark.hh:89
static const int minExpID
Definition: XrdNetPMark.hh:90