/*
 * Copyright (C) the libgit2 contributors. All rights reserved.
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
/**
 * License: GPL-2.0(Linking Exception)
 */
module libgit2.cert;


/*
 * @file git2/cert.h
 * @brief Git certificate objects
 * @defgroup git_cert Certificate objects
 * @ingroup Git
 * @{
 */
extern (C):
nothrow @nogc:
public:

/**
 * Type of host certificate structure that is passed to the check callback
 */
enum git_cert_t
{
	/**
	 * No information about the certificate is available. This may
	 * happen when using curl.
	 */
	GIT_CERT_NONE,

	/**
	 * The `data` argument to the callback will be a pointer to
	 * the DER-encoded data.
	 */
	GIT_CERT_X509,

	/**
	 * The `data` argument to the callback will be a pointer to a
	 * `git_cert_hostkey` structure.
	 */
	GIT_CERT_HOSTKEY_LIBSSH2,

	/**
	 * The `data` argument to the callback will be a pointer to a
	 * `git_strarray` with `name:content` strings containing
	 * information about the certificate. This is used when using
	 * curl.
	 */
	GIT_CERT_STRARRAY,
}

//Declaration name in C language
enum
{
	GIT_CERT_NONE = .git_cert_t.GIT_CERT_NONE,
	GIT_CERT_X509 = .git_cert_t.GIT_CERT_X509,
	GIT_CERT_HOSTKEY_LIBSSH2 = .git_cert_t.GIT_CERT_HOSTKEY_LIBSSH2,
	GIT_CERT_STRARRAY = .git_cert_t.GIT_CERT_STRARRAY,
}

/**
 * Parent type for `git_cert_hostkey` and `git_cert_x509`.
 */
struct git_cert
{
	/**
	 * Type of certificate. A `GIT_CERT_` value.
	 */
	.git_cert_t cert_type;
}

/**
 * Callback for the user's custom certificate checks.
 *
 * Returns: 0 to proceed with the connection, < 0 to fail the connection or > 0 to indicate that the callback refused to act and that the existing validity determination should be honored
 */
/*
 * Params:
 *      cert = The host certificate
 *      valid = Whether the libgit2 checks (OpenSSL or WinHTTP) think this certificate is valid
 *      host = Hostname of the host libgit2 connected to
 *      payload = Payload provided by the caller
 */
alias git_transport_certificate_check_cb = int function(.git_cert* cert, int valid, const (char)* host, void* payload);

/**
 * Type of SSH host fingerprint
 */
enum git_cert_ssh_t
{
	/**
	 * MD5 is available
	 */
	GIT_CERT_SSH_MD5 = 1 << 0,

	/**
	 * SHA-1 is available
	 */
	GIT_CERT_SSH_SHA1 = 1 << 1,

	/**
	 * SHA-256 is available
	 */
	GIT_CERT_SSH_SHA256 = 1 << 2,

	/**
	 * Raw hostkey is available
	 */
	GIT_CERT_SSH_RAW = 1 << 3,
}

//Declaration name in C language
enum
{
	GIT_CERT_SSH_MD5 = .git_cert_ssh_t.GIT_CERT_SSH_MD5,
	GIT_CERT_SSH_SHA1 = .git_cert_ssh_t.GIT_CERT_SSH_SHA1,
	GIT_CERT_SSH_SHA256 = .git_cert_ssh_t.GIT_CERT_SSH_SHA256,
	GIT_CERT_SSH_RAW = .git_cert_ssh_t.GIT_CERT_SSH_RAW,
}

enum git_cert_ssh_raw_type_t
{
	/**
	 * The raw key is of an unknown type.
	 */
	GIT_CERT_SSH_RAW_TYPE_UNKNOWN = 0,

	/**
	 * The raw key is an RSA key.
	 */
	GIT_CERT_SSH_RAW_TYPE_RSA = 1,

	/**
	 * The raw key is a DSS key.
	 */
	GIT_CERT_SSH_RAW_TYPE_DSS = 2,

	/**
	 * The raw key is a ECDSA 256 key.
	 */
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_256 = 3,

	/**
	 * The raw key is a ECDSA 384 key.
	 */
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_384 = 4,

	/**
	 * The raw key is a ECDSA 521 key.
	 */
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_521 = 5,

	/**
	 * The raw key is a ED25519 key.
	 */
	GIT_CERT_SSH_RAW_TYPE_KEY_ED25519 = 6,
}

//Declaration name in C language
enum
{
	GIT_CERT_SSH_RAW_TYPE_UNKNOWN = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_UNKNOWN,
	GIT_CERT_SSH_RAW_TYPE_RSA = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_RSA,
	GIT_CERT_SSH_RAW_TYPE_DSS = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_DSS,
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_256 = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_256,
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_384 = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_384,
	GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_521 = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_KEY_ECDSA_521,
	GIT_CERT_SSH_RAW_TYPE_KEY_ED25519 = .git_cert_ssh_raw_type_t.GIT_CERT_SSH_RAW_TYPE_KEY_ED25519,
}

/**
 * Hostkey information taken from libssh2
 */
struct git_cert_hostkey
{
	/**
	 * The parent cert
	 */
	.git_cert parent;

	/**
	 * A bitmask containing the available fields.
	 */
	.git_cert_ssh_t type = cast(.git_cert_ssh_t)(0);

	/**
	 * Hostkey hash. If `type` has `GIT_CERT_SSH_MD5` set, this will
	 * have the MD5 hash of the hostkey.
	 */
	ubyte[16] hash_md5;

	/**
	 * Hostkey hash. If `type` has `GIT_CERT_SSH_SHA1` set, this will
	 * have the SHA-1 hash of the hostkey.
	 */
	ubyte[20] hash_sha1;

	/**
	 * Hostkey hash. If `type` has `GIT_CERT_SSH_SHA256` set, this will
	 * have the SHA-256 hash of the hostkey.
	 */
	ubyte[32] hash_sha256;

	/**
	 * Raw hostkey type. If `type` has `GIT_CERT_SSH_RAW` set, this will
	 * have the type of the raw hostkey.
	 */
	.git_cert_ssh_raw_type_t raw_type;

	/**
	 * Pointer to the raw hostkey. If `type` has `GIT_CERT_SSH_RAW` set,
	 * this will have the raw contents of the hostkey.
	 */
	const (char)* hostkey;

	/**
	 * Raw hostkey length. If `type` has `GIT_CERT_SSH_RAW` set, this will
	 * have the length of the raw contents of the hostkey.
	 */
	size_t hostkey_len;
}

/**
 * X.509 certificate information
 */
struct git_cert_x509
{
	/**
	 * The parent cert
	 */
	.git_cert parent;

	/**
	 * Pointer to the X.509 certificate data
	 */
	void* data;

	/**
	 * Length of the memory block pointed to by `data`.
	 */
	size_t len;
}

/* @} */