common_tls.h

Go to the documentation of this file.

// Copyright (C) 2021-2026 Internet Systems Consortium, Inc. ("ISC")
//
// 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/.
 
// Do not include this header directly: use crypto_tls.h instead.
 
#ifndef COMMON_TLS_H
#define COMMON_TLS_H

 
// Verify that this file was not directly included.
#ifndef CRYPTO_TLS_H
#error crypto_tls.h must be included in place of common_tls.h
#endif
 
#include <cryptolink/cryptolink.h>
 
#include <cstdint>
 
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
#include <netinet/in.h>
#include <sys/socket.h>
 
namespace isc {
namespace asiolink {

enum TlsRole : uint16_t { CLIENT, SERVER };

class TlsContext;

typedef boost::shared_ptr<TlsContext> TlsContextPtr;

class TlsContextBase : private boost::noncopyable {
public:
    virtual ~TlsContextBase() { }

    explicit TlsContextBase(TlsRole role) : role_(role) { }

    TlsRole getRole() const {
        return (role_);
    }


    static void configure(TlsContextPtr& context,
                          TlsRole role,
                          const std::string& ca_file,
                          const std::string& cert_file,
                          const std::string& key_file,
                          bool cert_required = true);

    virtual bool getCertRequired() const = 0;
 
protected:
    virtual void setCertRequired(bool cert_required) = 0;

    virtual void loadCaFile(const std::string& ca_file) = 0;

    virtual void loadCaPath(const std::string& ca_path) = 0;

    virtual void loadCertFile(const std::string& cert_file) = 0;

    virtual void loadKeyFile(const std::string& key_file) = 0;
 
public:
    TlsRole role_;
};
 
class StreamService {
public:
    StreamService(const IOServicePtr& io_service, TlsContextPtr& tls_context) :
        io_service_(io_service), tls_context_(tls_context) {
    }
private:
    IOServicePtr io_service_;

    TlsContextPtr tls_context_;
};

template <typename Callback, typename TlsStreamImpl>
class TlsStreamBase : public StreamService, public TlsStreamImpl {
public:

    TlsStreamBase(const IOServicePtr& service, TlsContextPtr context);

    virtual ~TlsStreamBase() { }

    TlsRole getRole() const {
        return (role_);
    }

    virtual void handshake(Callback& callback) = 0;

    virtual void shutdown(Callback& callback) = 0;

    virtual std::string getSubject() = 0;

    virtual std::string getIssuer() = 0;

    TlsRole role_;
};
 
} // namespace asiolink
} // namespace isc
 
#endif // COMMON_TLS_H