Signature.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 Quarkslab
 *
 * 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 LIEF_PE_SIGNATURE_H
#define LIEF_PE_SIGNATURE_H
 
#include <string_view>
 
#include "LIEF/Object.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/span.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/PE/signature/ContentInfo.hpp"
#include "LIEF/PE/signature/SignerInfo.hpp"
#include "LIEF/PE/signature/x509.hpp"
 
#include "LIEF/PE/enums.hpp"
 
#include "LIEF/enums.hpp"
#include "LIEF/iterators.hpp"
 
 
namespace LIEF::PE {
 
class SignatureParser;
class Binary;

class LIEF_API Signature : public Object {
 
  friend class SignatureParser;
  friend class Parser;
  friend class Binary;
 
  public:
  static std::vector<uint8_t> hash(const std::vector<uint8_t>& input,
                                   ALGORITHMS algo) {
    return hash(input.data(), input.size(), algo);
  }
 
  static std::vector<uint8_t> hash(const uint8_t* buffer, size_t size,
                                   ALGORITHMS algo);
 
  public:
  using it_const_crt = const_ref_iterator<const std::vector<x509>&>;

  using it_crt = ref_iterator<std::vector<x509>&>;

  using it_const_signers_t = const_ref_iterator<const std::vector<SignerInfo>&>;

  using it_signers_t = ref_iterator<std::vector<SignerInfo>&>;

  enum class VERIFICATION_FLAGS : uint32_t {
    // clang-format off
    OK                            = 0,
    INVALID_SIGNER                = 1 << 0,
    UNSUPPORTED_ALGORITHM         = 1 << 1,
    INCONSISTENT_DIGEST_ALGORITHM = 1 << 2,
    CERT_NOT_FOUND                = 1 << 3,
    CORRUPTED_CONTENT_INFO        = 1 << 4,
    CORRUPTED_AUTH_DATA           = 1 << 5,
    MISSING_PKCS9_MESSAGE_DIGEST  = 1 << 6,
    BAD_DIGEST                    = 1 << 7,
    BAD_SIGNATURE                 = 1 << 8,
    NO_SIGNATURE                  = 1 << 9,
    CERT_EXPIRED                  = 1 << 10,
    CERT_FUTURE                   = 1 << 11,
    // clang-format on
  };

  static std::string flag_to_string(VERIFICATION_FLAGS flag);

  enum class VERIFICATION_CHECKS : uint32_t {
    DEFAULT = 1 << 0,

    HASH_ONLY = 1 << 1,

    LIFETIME_SIGNING = 1 << 2,

    SKIP_CERT_TIME = 1 << 3,
  };
 
  Signature();
  Signature(const Signature&);
  Signature& operator=(const Signature&);
 
  Signature(Signature&&);
  Signature& operator=(Signature&&);

  uint32_t version() const {
    return version_;
  }

  ALGORITHMS digest_algorithm() const {
    return digest_algorithm_;
  }

  const ContentInfo& content_info() const LIEF_LIFETIMEBOUND {
    return content_info_;
  }

  it_const_crt certificates() const LIEF_LIFETIMEBOUND {
    return certificates_;
  }
 
  it_crt certificates() LIEF_LIFETIMEBOUND {
    return certificates_;
  }

  it_const_signers_t signers() const LIEF_LIFETIMEBOUND {
    return signers_;
  }
 
  it_signers_t signers() LIEF_LIFETIMEBOUND {
    return signers_;
  }

  span<const uint8_t> raw_der() const LIEF_LIFETIMEBOUND {
    return original_raw_signature_;
  }

  const x509*
      find_crt(const std::vector<uint8_t>& serialno) const LIEF_LIFETIMEBOUND;

  const x509* find_crt_subject(std::string_view subject) const LIEF_LIFETIMEBOUND;

  const x509* find_crt_subject(
      std::string_view subject, const std::vector<uint8_t>& serialno
  ) const LIEF_LIFETIMEBOUND;

  const x509* find_crt_issuer(std::string_view issuer) const LIEF_LIFETIMEBOUND;

  const x509* find_crt_issuer(
      std::string_view issuer, const std::vector<uint8_t>& serialno
  ) const LIEF_LIFETIMEBOUND;

  VERIFICATION_FLAGS
  check(VERIFICATION_CHECKS checks = VERIFICATION_CHECKS::DEFAULT) const;
 
  void accept(Visitor& visitor) const override;
 
  ~Signature() override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const Signature& signature);
 
  private:
  uint32_t version_ = 0;
  ALGORITHMS digest_algorithm_ = ALGORITHMS::UNKNOWN;
  ContentInfo content_info_;
  std::vector<x509> certificates_;
  std::vector<SignerInfo> signers_;
 
  uint64_t content_info_start_ = 0;
  uint64_t content_info_end_ = 0;
 
  std::vector<uint8_t> original_raw_signature_;
};
 
 
}
 
 
ENABLE_BITMASK_OPERATORS(LIEF::PE::Signature::VERIFICATION_FLAGS);
ENABLE_BITMASK_OPERATORS(LIEF::PE::Signature::VERIFICATION_CHECKS);
 
 
#endif