jwt.hpp

Go to the documentation of this file.

// Licensed 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

#ifndef __PROCESS_JWT_HPP__
#define __PROCESS_JWT_HPP__

#include <ostream>
#include <string>

#ifdef __WINDOWS__
// NOTE: This must be included before the OpenSSL headers as it includes
// `WinSock2.h` and `Windows.h` in the correct order.
#include <stout/windows.hpp>
#endif // __WINDOWS__

#include <openssl/rsa.h>

#include <stout/json.hpp>
#include <stout/option.hpp>
#include <stout/try.hpp>

namespace process {
namespace http {
namespace authentication {

// Represents the various errors that can be returned when parsing or
// creating JSON Web Tokens. This can be useful to create proper
// responses to HTTP requests that included a token.
class JWTError : public Error {
public:
  enum class Type {
    INVALID_TOKEN, // Invalid token.
    UNKNOWN        // Internal error/all other errors.
  };

  JWTError(const std::string& message, Type _type)
    : Error(message), type(_type) {};

  const Type type;
};


class JWT
{
public:
  enum class Alg
  {
    None,
    HS256,
    RS256
  };

  struct Header
  {
    Alg alg;
    Option<std::string> typ;
  };

  static Try<JWT, JWTError> parse(const std::string& token);

  static Try<JWT, JWTError> parse(
      const std::string& token,
      const std::string& secret);

  static Try<JWT, JWTError> parse(
      const std::string& token,
      std::shared_ptr<RSA> publicKey);

  static Try<JWT, JWTError> create(const JSON::Object& payload);

  static Try<JWT, JWTError> create(
      const JSON::Object& payload,
      const std::string& secret);

  static Try<JWT, JWTError> create(
      const JSON::Object& payload,
      std::shared_ptr<RSA> privateKey);

  const Header header;
  const JSON::Object payload;
  const Option<std::string> signature;

private:
  JWT(const Header& header,
      const JSON::Object& payload,
      const Option<std::string>& signature);
};

std::ostream& operator<<(std::ostream& stream, const JWT& jwt);

} // namespace authentication {
} // namespace http {
} // namespace process {

#endif // __PROCESS_JWT_HPP__