/usr/include/shibsp/handler/LogoutHandler.h is in libshibsp-dev 2.6.0+dfsg1-4+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | /**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file shibsp/handler/LogoutHandler.h
*
* Base class for logout-related handlers.
*/
#ifndef __shibsp_logout_h__
#define __shibsp_logout_h__
#include <shibsp/handler/RemotedHandler.h>
namespace shibsp {
#ifndef SHIBSP_LITE
class SHIBSP_API LogoutEvent;
#endif
#if defined (_MSC_VER)
#pragma warning( push )
#pragma warning( disable : 4251 )
#endif
/**
* Base class for logout-related handlers.
*/
class SHIBSP_API LogoutHandler : public RemotedHandler
{
public:
virtual ~LogoutHandler();
/**
* The base method will iteratively attempt front-channel notification
* of logout of the current session, and after the final round trip will
* perform back-channel notification. Nothing will be done unless the
* handler detects that it is the "top" level logout handler.
* If the method returns false, then the specialized class should perform
* its work assuming that the notifications are completed.
*
* Note that the current session is NOT removed from the cache.
*
* @param request SP request context
* @param isHandler true iff executing in the context of a direct handler invocation
* @return a pair containing a "request completed" indicator and a server-specific response code
*/
std::pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
/**
* A remoted procedure that will perform any necessary back-channel
* notifications. The input structure must contain an "application_id" member,
* and a "sessions" list containing the session keys, along with an integer
* member called "notify" with a value of 1.
*
* @param in incoming DDF message
* @param out stream to write outgoing DDF message to
*/
void receive(DDF& in, std::ostream& out);
const char* getEventType() const;
protected:
LogoutHandler();
/** Flag indicating whether the subclass is acting as a LogoutInitiator. */
bool m_initiator;
/** Array of query string parameters to preserve across front-channel notifications, if present. */
std::vector<std::string> m_preserve;
/**
* Perform front-channel logout notifications for an Application.
*
* @param application the Application to notify
* @param request last request from browser
* @param response response to use for next notification
* @param params map of query string parameters to preserve across this notification
* @return indicator of a completed response along with the status code to return from the handler
*/
std::pair<bool,long> notifyFrontChannel(
const Application& application,
const xmltooling::HTTPRequest& request,
xmltooling::HTTPResponse& response,
const std::map<std::string,std::string>* params=nullptr
) const;
/**
* Perform back-channel logout notifications for an Application.
*
* @param application the Application to notify
* @param requestURL requestURL that resulted in method call
* @param sessions array of session keys being logged out
* @param local true iff the logout operation is local to the SP, false iff global
* @return true iff all notifications succeeded
*/
bool notifyBackChannel(
const Application& application, const char* requestURL, const std::vector<std::string>& sessions, bool local
) const;
/**
* @deprecated
* Sends a response template to the user agent informing it of the results of a logout attempt.
*
* @param application the Application to use in determining the logout template
* @param request the HTTP client request to supply to the template
* @param response the HTTP response to use
* @param local true iff the logout operation was local to the SP, false iff global
* @param status optional logoutStatus key value to add to template
*/
std::pair<bool,long> sendLogoutPage(
const Application& application,
const xmltooling::HTTPRequest& request,
xmltooling::HTTPResponse& response,
bool local=true,
const char* status=nullptr
) const;
/**
* Sends a response template to the user agent informing it of the results of a logout attempt.
*
* @param application the Application to use in determining the logout template
* @param request the HTTP client request to supply to the template
* @param response the HTTP response to use
* @param type designates the prefix of logout template name to use
*/
std::pair<bool,long> sendLogoutPage(
const Application& application,
const xmltooling::HTTPRequest& request,
xmltooling::HTTPResponse& response,
const char* type
) const;
#ifndef SHIBSP_LITE
/**
* Creates a new LogoutEvent for the event log.
*
* @param application the Application associated with the event
* @param request the HTTP client request associated with the event, or nullptr
* @param session the user session associated with the event, or nullptr
* @return a fresh LogoutEvent, prepopulated by the input parameters, or nullptr if an error occurs
*/
virtual LogoutEvent* newLogoutEvent(
const Application& application,
const xmltooling::HTTPRequest* request=nullptr,
const Session* session=nullptr
) const;
#endif
};
#if defined (_MSC_VER)
#pragma warning( pop )
#endif
};
#endif /* __shibsp_logout_h__ */
|