2 * The Shibboleth License, Version 1.
4 * University Corporation for Advanced Internet Development, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * Redistributions of source code must retain the above copyright notice, this
12 * list of conditions and the following disclaimer.
14 * Redistributions in binary form must reproduce the above copyright notice,
15 * this list of conditions and the following disclaimer in the documentation
16 * and/or other materials provided with the distribution, if any, must include
17 * the following acknowledgment: "This product includes software developed by
18 * the University Corporation for Advanced Internet Development
19 * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
20 * may appear in the software itself, if and wherever such third-party
21 * acknowledgments normally appear.
23 * Neither the name of Shibboleth nor the names of its contributors, nor
24 * Internet2, nor the University Corporation for Advanced Internet Development,
25 * Inc., nor UCAID may be used to endorse or promote products derived from this
26 * software without specific prior written permission. For written permission,
27 * please contact shibboleth@shibboleth.org
29 * Products derived from this software may not be called Shibboleth, Internet2,
30 * UCAID, or the University Corporation for Advanced Internet Development, nor
31 * may Shibboleth appear in their name, without prior written permission of the
32 * University Corporation for Advanced Internet Development.
35 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
36 * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
38 * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
39 * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
40 * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
41 * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
42 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
43 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
44 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
47 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 * shib-target.h -- top-level header file for the SHIB Common Target Library
53 * Created by: Derek Atkins <derek@ihtfp.com>
62 # include <saml/saml.h>
63 # include <shib/shib.h>
64 # include <shib/shib-threads.h>
68 # ifndef SHIBTARGET_EXPORTS
69 # define SHIBTARGET_EXPORTS __declspec(dllimport)
72 # define SHIBTARGET_EXPORTS
75 #include <shib-target/shibrpc.h>
84 typedef SOCKET ShibSocket;
85 typedef const char* ShibSockName;
86 #define SHIB_SHAR_SOCKET "127.0.0.1:12345" /* TCP host:port */
90 typedef int ShibSocket;
91 typedef const char* ShibSockName;
92 #define SHIB_SHAR_SOCKET "/tmp/shar-socket" /* Unix domain socket */
98 /* Create an RPC Client handle for the _connected_ socket sock, attaching
99 * the RPC program and version.
101 * returns a CLIENT on success, or NULL on error. The caller can
102 * call clnt_pcreateerror ("<string>") to output an error message from
105 SHIBTARGET_EXPORTS CLIENT * shibrpc_client_create (ShibSocket sock, u_long program, u_long version);
109 /* Create a new socket and put it into sock.
111 * Returns 0 on success, non-zero on error
113 SHIBTARGET_EXPORTS int shib_sock_create (ShibSocket *sock);
116 * bind the socket s to the "port" name.
118 * Returns 0 on success; non-zero on error.
120 * SIDE EFFECT: On error, the socket is closed!
122 SHIBTARGET_EXPORTS int shib_sock_bind (ShibSocket s, ShibSockName name);
125 * connect the socket s to the "port" name on the local host.
127 * Returns 0 on success; non-zero on error.
129 SHIBTARGET_EXPORTS int shib_sock_connect (ShibSocket s, ShibSockName name);
132 * accept a connection. Returns 0 on success, non-zero on failure.
134 SHIBTARGET_EXPORTS int shib_sock_accept (ShibSocket listener, ShibSocket* s);
139 SHIBTARGET_EXPORTS void shib_sock_close (ShibSocket s, ShibSockName name);
141 /* shib-target.cpp */
143 /* application names */
144 #define SHIBTARGET_GENERAL "general"
145 #define SHIBTARGET_SHAR "shar"
146 #define SHIBTARGET_SHIRE "shire"
147 #define SHIBTARGET_RM "rm"
148 #define SHIBTARGET_POLICIES "policies"
150 /* configuration tags */
151 #define SHIBTARGET_TAG_LOGGER "logger"
152 #define SHIBTARGET_TAG_SCHEMAS "schemadir"
153 #define SHIBTARGET_TAG_CERTFILE "certfile"
154 #define SHIBTARGET_TAG_KEYFILE "keyfile"
155 #define SHIBTARGET_TAG_KEYPASS "keypass"
156 #define SHIBTARGET_TAG_CALIST "calist"
158 #define SHIBTARGET_TAG_AATIMEOUT "AATimeout"
159 #define SHIBTARGET_TAG_AACONNECTTO "AAConnectTimeout"
160 #define SHIBTARGET_TAG_SAMLCOMPAT "SAMLCompat"
162 #define SHIBTARGET_TAG_METADATA "metadata"
164 #define SHIBTARGET_TAG_DEFAULTLIFE "defaultLife"
166 #define SHIBTARGET_TAG_CACHETYPE "cacheType"
167 #define SHIBTARGET_TAG_CACHECLEAN "cacheClean"
168 #define SHIBTARGET_TAG_CACHETIMEOUT "cacheTimeout"
170 #define SHIBTARGET_TAG_REQATTRS "requestAttributes"
172 /* initialize and finalize the target library (return 0 on success, 1 on failure) */
173 SHIBTARGET_EXPORTS int shib_target_initialize (const char* application, const char* ini_file);
174 SHIBTARGET_EXPORTS void shib_target_finalize (void);
176 /* access socket specifics from C code */
177 SHIBTARGET_EXPORTS ShibSockName shib_target_sockname(void);
178 SHIBTARGET_EXPORTS ShibSockName shib_target_sockacl(unsigned int index);
184 namespace shibtarget {
186 class SHIBTARGET_EXPORTS Resource
189 Resource(const char* resource_url);
190 Resource(std::string resource_url);
193 const char* getResource() const;
194 const char* getURL() const;
195 bool equals(Resource*) const;
196 saml::Iterator<saml::SAMLAttribute*> getDesignators() const;
199 ResourcePriv *m_priv;
202 class RPCHandleInternal;
203 class SHIBTARGET_EXPORTS RPCHandle
206 RPCHandle(ShibSockName shar, u_long program, u_long version);
209 CLIENT * connect(void); /* locks the HANDLE and returns the CLIENT */
210 void release(void); /* unlocks the HANDLE */
211 void disconnect(void); /* disconnects */
213 // A simple function to get a handle
214 // Note that it does not check that an existing handle matches the request.
215 static RPCHandle* get_handle(shibboleth::ThreadKey* key,
216 ShibSockName shar, u_long program,
220 RPCHandleInternal *m_priv;
223 class SHIBTARGET_EXPORTS ShibTargetException : public std::exception
226 explicit ShibTargetException() : m_origin(NULL), m_code(SHIBRPC_OK) {}
227 explicit ShibTargetException(ShibRpcStatus code, const char* msg, const XMLCh* origin = NULL) : m_code(code)
228 { if (msg) m_msg=msg; m_origin = XMLString::replicate(origin); }
229 explicit ShibTargetException(ShibRpcStatus code, const std::string& msg, const XMLCh* origin = NULL) : m_msg(msg)
230 { m_code=code; m_origin = XMLString::replicate(origin); }
231 virtual ~ShibTargetException() throw () { if (m_origin) XMLString::release(&m_origin); }
232 virtual const char* what() const throw () { return (m_msg.c_str()); }
233 virtual ShibRpcStatus which() const throw () { return (m_code); }
234 virtual const XMLCh* where() const throw () { return m_origin; }
237 ShibRpcStatus m_code;
243 class SHIBTARGET_EXPORTS RPCError
246 RPCError() { init(0, "", NULL); }
247 RPCError(ShibRpcError* error);
248 RPCError(int s, char const* st, const XMLCh* orig = NULL) { init (s,st,orig); }
249 RPCError(ShibTargetException &exp) { init(exp.which(), exp.what(), exp.where()); }
255 // Return a set of strings that corresponds to the type, text, and desc
256 const char* getType();
257 const char* getText();
258 const char* getDesc();
259 std::string getOriginErrorURL();
260 std::string getOriginContactName();
261 std::string getOriginContactEmail();
265 void init(int stat, char const* msg, const XMLCh* origin);
266 RPCErrorPriv* m_priv;
269 // The ShibTargetError is used by the high-level SHIRE and RM methods
270 // to notify the handlers of high-level errors.
273 class SHIBTARGET_EXPORTS ShibMLP {
278 void insert (const std::string& key, const std::string& value);
279 void insert (const std::string& key, const char* value) {
280 std::string v = value;
283 void insert (const char* key, const std::string& value) {
287 void insert (const char* key, const char* value) {
288 std::string k = key, v = value;
291 void insert (RPCError& e);
293 void clear () { m_map.clear(); }
295 std::string run (std::istream& s) const;
296 std::string run (const std::string& input) const;
297 std::string run (const char* input) const {
298 std::string i = input;
304 std::map<std::string,std::string> m_map;
307 class SHIBTARGET_EXPORTS ShibTargetResponse
310 // What to do with the response
318 // How to log the message, if any. (NONE implies no log_msg)
331 std::string log_msg; // message to log if log_level != NONE
332 std::string redirect_to; // where to redirect if status == REDIRECT
333 ShibMLP mlp; // MLP information if has_mlp == true
336 class SHIBTARGET_EXPORTS ShibTargetError : public std::exception
339 explicit ShibTargetError(ShibTargetResponse *resp = NULL) { m_resp = resp; }
340 virtual ~ShibTargetError() throw () { if (m_resp) delete m_resp; }
341 virtual const ShibTargetResponse* getError() { return m_resp; }
344 ShibTargetResponse *m_resp;
347 class SHIBTARGET_EXPORTS SHIREConfig
356 class SHIBTARGET_EXPORTS ShibINI;
357 class SHIBTARGET_EXPORTS SHIRE
360 SHIRE(RPCHandle *rpc, SHIREConfig config, std::string shire_url);
363 RPCError* sessionIsValid(const char* cookie, const char* ip, const char* url);
364 RPCError* sessionCreate(const char* post, const char* ip,
365 std::string &cookie);
367 //ShibTargetResponse* is_valid(ShibINI& ini, const char* serverName,
368 // const char *cookie, const char *target_url);
369 //ShibTargetResponse* create();
375 class SHIBTARGET_EXPORTS RMConfig
382 class SHIBTARGET_EXPORTS RM
385 RM(RPCHandle *rpc, RMConfig config);
388 RPCError* getAssertions(const char* cookie, const char* ip,
390 std::vector<saml::SAMLAssertion*> &assertions,
391 saml::SAMLAuthenticationStatement **statement = NULL);
392 static void serialize(saml::SAMLAssertion &assertion, std::string &result);
393 static saml::Iterator<saml::SAMLAttribute*> getAttributes(saml::SAMLAssertion &assertion);
399 class SHIBTARGET_EXPORTS ShibINI {
401 ShibINI (std::string& file, bool case_sensitive = true) { init(file,case_sensitive); }
402 ShibINI (const char *file, bool case_sensitive = true) {
403 std::string f = file;
404 init(f, case_sensitive);
410 const std::string get (const std::string& header, const std::string& tag);
411 const std::string get (const char* header, const char* tag) {
412 std::string h = header, t = tag;
416 const std::string operator() (const std::string& header, const std::string& tag) {
417 return get(header,tag);
419 const std::string operator() (const char* header, const char* tag) {
420 std::string h = header, t = tag;
424 bool exists(const std::string& header);
425 bool exists(const std::string& header, const std::string& tag);
427 bool exists(const char* header) {
428 std::string s = header;
431 bool exists(const char* header, const char* tag) {
432 std::string h = header, t = tag;
436 // Special method to look for a tag in one header and maybe in the
437 // 'SHIBTARGET_GENERAL' header
438 bool get_tag(std::string& header, std::string& tag, bool try_general,
439 std::string* result);
441 bool get_tag(std::string& header, const char* tag, bool try_general,
442 std::string* result) {
444 return get_tag (header,t,try_general,result);
447 bool get_tag(const char* header, const char* tag, bool try_general,
448 std::string* result) {
449 std::string h = header, t = tag;
450 return get_tag (h,t,try_general,result);
453 // Dump out the inifile to the output stream
454 void dump(std::ostream& os);
458 // The begin() functions reset the iterator and return the first element
459 // (or 0 if there are no elements.)
460 // The next() functions return the next element, or 0 if there are no
464 // for (const foo* current = begin(); current; current = next()) {
468 // NOTE: Holding an Iterator will lock the INI file and cause it to
469 // stop updating itself. You should destroy the iterator as soon as
470 // you are done with it.
472 // ALSO NOTE: the string* returned from the Iterator is only valid
473 // while you hold the iterator. You should copy the de-reference
474 // of the pointer to your own copy if you want to keep the string.
476 class SHIBTARGET_EXPORTS Iterator {
478 virtual ~Iterator() {}
479 virtual const std::string* begin() = 0;
480 virtual const std::string* next() = 0;
483 Iterator* header_iterator();
484 Iterator* tag_iterator(const std::string& header);
486 static bool boolean(std::string& value);
490 void init(std::string& file, bool case_sensitive);
493 class SHIBTARGET_EXPORTS ShibTargetConfig
496 static void preinit();
497 static ShibTargetConfig& init(const char* app_name, const char* inifile);
498 static ShibTargetConfig& getConfig();
499 virtual void init() = 0;
500 virtual void shutdown() = 0;
501 virtual ~ShibTargetConfig() {}
502 virtual ShibINI& getINI() = 0;
503 virtual saml::Iterator<const XMLCh*> getPolicies() = 0;
509 #endif /* SHIB_TARGET_H */