libreoffice-online/common/Authorization.hpp
Michael Meeks 7183a3d3de spdx: improve machine and human readability of headers.
Change-Id: Ice934380029bf27054e830fffc07a5d037d1430f
Signed-off-by: Michael Meeks <michael.meeks@collabora.com>
2023-11-14 19:36:31 +00:00

82 lines
1.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* Copyright the Collabora Online contributors.
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
// WOPI Authorization
#pragma once
#include <string>
#include <vector>
namespace Poco
{
namespace Net
{
class HTTPRequest;
}
class URI;
} // namespace Poco
/// Class to keep the authorization data, which can be either access_token or access_header.
class Authorization
{
public:
enum class Type
{
None, //< Unlike Expired, this implies no Authorization needed.
Token,
Header,
Expired //< The server is rejecting the current authorization key.
};
private:
Type _type;
std::string _data;
public:
Authorization()
: _type(Type::None)
{
}
Authorization(Type type, const std::string& data)
: _type(type)
, _data(data)
{
}
/// Create an Authorization instance from the URI query parameters.
/// Expects access_token (preferred) or access_header.
static Authorization create(const Poco::URI& uri);
static Authorization create(const std::string& uri);
void resetAccessToken(std::string accessToken)
{
_type = Type::Token;
_data = std::move(accessToken);
}
/// Expire the Authorization data.
void expire() { _type = Type::Expired; }
/// Returns true iff the Authorization data is invalid.
bool isExpired() const { return _type == Type::Expired; }
/// Set the access_token parameter to the given URI.
void authorizeURI(Poco::URI& uri) const;
/// Set the Authorization: header in request.
void authorizeRequest(Poco::Net::HTTPRequest& request) const;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */