00001 #ifndef __SEC_ENTITYATTR_H__ 00002 #define __SEC_ENTITYATTR_H__ 00003 /******************************************************************************/ 00004 /* */ 00005 /* X r d S e c E n t i t y A t t r . h h */ 00006 /* */ 00007 /* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University */ 00008 /* Produced by Andrew Hanushevsky for Stanford University under contract */ 00009 /* DE-AC02-76-SFO0515 with the Department of Energy */ 00010 /* */ 00011 /* This file is part of the XRootD software suite. */ 00012 /* */ 00013 /* XRootD is free software: you can redistribute it and/or modify it under */ 00014 /* the terms of the GNU Lesser General Public License as published by the */ 00015 /* Free Software Foundation, either version 3 of the License, or (at your */ 00016 /* option) any later version. */ 00017 /* */ 00018 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */ 00019 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */ 00020 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */ 00021 /* License for more details. */ 00022 /* */ 00023 /* You should have received a copy of the GNU Lesser General Public License */ 00024 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */ 00025 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */ 00026 /* */ 00027 /* The copyright holder's institutional names and contributor's names may not */ 00028 /* be used to endorse or promote products derived from this software without */ 00029 /* specific prior written permission of the institution or contributor. */ 00030 /******************************************************************************/ 00031 00032 //------------------------------------------------------------------------------ 00039 //------------------------------------------------------------------------------ 00040 00041 #include <sys/types.h> 00042 00043 #include <string> 00044 #include <vector> 00045 00046 class XrdSecAttr; 00047 class XrdSecEntityAttrCB; 00048 class XrdSecEntityXtra; 00049 00050 /******************************************************************************/ 00051 /* X r d S e c E n t i t y A t t r */ 00052 /******************************************************************************/ 00053 00054 class XrdSecEntityAttr 00055 { 00056 public: 00057 friend class XrdSecEntity; 00058 00059 //------------------------------------------------------------------------------ 00066 //------------------------------------------------------------------------------ 00067 00068 bool Add(XrdSecAttr &attr); 00069 00070 //------------------------------------------------------------------------------ 00080 //------------------------------------------------------------------------------ 00081 00082 bool Add(const std::string &key, 00083 const std::string &val, bool replace=false); 00084 00085 //------------------------------------------------------------------------------ 00092 //------------------------------------------------------------------------------ 00093 00094 XrdSecAttr *Get(const void *sigkey); 00095 00096 //------------------------------------------------------------------------------ 00104 //------------------------------------------------------------------------------ 00105 00106 bool Get(const std::string &key, std::string &val); 00107 00108 //------------------------------------------------------------------------------ 00112 //------------------------------------------------------------------------------ 00113 00114 std::vector<std::string> Keys(); 00115 00116 //------------------------------------------------------------------------------ 00120 //------------------------------------------------------------------------------ 00121 00122 void List(XrdSecEntityAttrCB &attrCB); 00123 00124 //------------------------------------------------------------------------------ 00128 //------------------------------------------------------------------------------ 00129 00130 XrdSecEntityAttr(XrdSecEntityXtra *xtra) : entXtra(xtra) {} 00131 00132 ~XrdSecEntityAttr() {} 00133 00134 private: 00135 00136 XrdSecEntityXtra *entXtra; 00137 }; 00138 00139 /******************************************************************************/ 00140 /* X r d S e c E n t i t y A t t r C B */ 00141 /******************************************************************************/ 00142 00143 // The XrdSecEntityAttrCB class defines the callback object passed to the 00144 // XrdSecEntity::List() method to iteratively obtain the key-value attribute 00145 // pairs associated with the entity. The XrdSecEntityAttrCB::Attr() method is 00146 // called for each key-value pair. The end of the list is indicated by calling 00147 // Attr() with nil key-value pointers. The Attr() method should not call 00148 // the XrdSecEntity::Add() or XrdSecEntity::Get() methods; otherwise, a 00149 // deadlock will occur. 00150 // 00151 class XrdSecEntityAttrCB 00152 { 00153 public: 00154 00155 //------------------------------------------------------------------------------ 00163 //------------------------------------------------------------------------------ 00164 00165 enum Action {Delete = -1, 00166 Stop = 0, 00167 Next = 1 00168 }; 00169 00170 virtual Action Attr(const char *key, const char *val) = 0; 00171 00172 //------------------------------------------------------------------------------ 00174 //------------------------------------------------------------------------------ 00175 00176 XrdSecEntityAttrCB() {} 00177 virtual ~XrdSecEntityAttrCB() {} 00178 }; 00179 #endif