thodg/libgit2/include/git2/cert.h

• Show log

  Commit

• Hash : 606f6e21
  Author :
  Date : 2019-09-09T17:01:44
  

  cert: move cert enums & struct to its own header

Download

• include/git2/cert.h

• /*
   * 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.
   */
  #ifndef INCLUDE_git_cert_h__
  #define INCLUDE_git_cert_h__
  
  #include "common.h"
  
  /**
   * @file git2/cert.h
   * @brief Git certificate objects
   * @defgroup git_cert Certificate objects
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Type of host certificate structure that is passed to the check callback
   */
  typedef 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,
  } git_cert_t;
  
  /**
   * 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.
   *
   * @param cert The host certificate
   * @param valid Whether the libgit2 checks (OpenSSL or WinHTTP) think
   * this certificate is valid
   * @param host Hostname of the host libgit2 connected to
   * @param payload Payload provided by the caller
   * @return 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
   */
  typedef int GIT_CALLBACK(git_transport_certificate_check_cb)(git_cert *cert, int valid, const char *host, void *payload);
  
  /**
   * Type of SSH host fingerprint
   */
  typedef enum {
  	/** MD5 is available */
  	GIT_CERT_SSH_MD5 = (1 << 0),
  	/** SHA-1 is available */
  	GIT_CERT_SSH_SHA1 = (1 << 1),
  } git_cert_ssh_t;
  
  /**
   * Hostkey information taken from libssh2
   */
  typedef struct {
  	git_cert parent; /**< The parent cert */
  
  	/**
  	 * A hostkey type from libssh2, either
  	 * `GIT_CERT_SSH_MD5` or `GIT_CERT_SSH_SHA1`
  	 */
  	git_cert_ssh_t type;
  
  	/**
  	 * Hostkey hash. If type has `GIT_CERT_SSH_MD5` set, this will
  	 * have the MD5 hash of the hostkey.
  	 */
  	unsigned char hash_md5[16];
  
  	/**
  	 * Hostkey hash. If type has `GIT_CERT_SSH_SHA1` set, this will
  	 * have the SHA-1 hash of the hostkey.
  	 */
  	unsigned char hash_sha1[20];
  } git_cert_hostkey;
  
  /**
   * X.509 certificate information
   */
  typedef struct {
  	git_cert parent; /**< The parent cert */
  
  	/**
  	 * Pointer to the X.509 certificate data
  	 */
  	void *data;
  
  	/**
  	 * Length of the memory block pointed to by `data`.
  	 */
  	size_t len;
  } git_cert_x509;
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download