Tagging 2.4RC1 release.
[shibboleth/sp.git] / shibsp / GSSRequest.h
1 /*
2  *  Copyright 2010 Internet2
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /**
18  * @file shibsp/GSSRequest.h
19  *
20  * Interface to a GSS-authenticated request.
21  */
22
23 #if !defined(__shibsp_gssreq_h__) && defined(HAVE_GSSAPI)
24 #define __shibsp_gssreq_h__
25
26 #include <shibsp/base.h>
27 #include <xmltooling/io/GenericRequest.h>
28
29 #ifdef HAVE_GSSGNU
30 # include <gss.h>
31 #elif defined HAVE_GSSMIT
32 # include <gssapi/gssapi.h>
33 # include <gssapi/gssapi_generic.h>
34 #else
35 # include <gssapi.h>
36 #endif
37
38 namespace shibsp {
39
40     /**
41      * Interface to a GSS-authenticated request.
42      */
43     class SHIBSP_API GSSRequest : public virtual xmltooling::GenericRequest
44     {
45     protected:
46         GSSRequest();
47     public:
48         virtual ~GSSRequest();
49
50         /**
51          * Returns the GSS-API context established for this request, or
52          * GSS_C_NO_CONTEXT if none is available.
53          *
54          * @return  a GSS-API context handle, or GSS_C_NO_CONTEXT
55          */
56         virtual gss_ctx_id_t getGSSContext() const=0;
57     };
58 };
59
60 #endif /* __shibsp_gssreq_h__ */