thodg/libgit2/src/transports/auth.h

• Show log

  Commit

• Hash : f0e693b1
  Author :
  Date : 2021-09-07T17:53:49
  

  str: introduce `git_str` for internal, `git_buf` is external
  
  libgit2 has two distinct requirements that were previously solved by
  `git_buf`.  We require:
  
  1. A general purpose string class that provides a number of utility APIs
     for manipulating data (eg, concatenating, truncating, etc).
  2. A structure that we can use to return strings to callers that they
     can take ownership of.
  
  By using a single class (`git_buf`) for both of these purposes, we have
  confused the API to the point that refactorings are difficult and
  reasoning about correctness is also difficult.
  
  Move the utility class `git_buf` to be called `git_str`: this represents
  its general purpose, as an internal string buffer class.  The name also
  is an homage to Junio Hamano ("gitstr").
  
  The public API remains `git_buf`, and has a much smaller footprint.  It
  is generally only used as an "out" param with strict requirements that
  follow the documentation.  (Exceptions exist for some legacy APIs to
  avoid breaking callers unnecessarily.)
  
  Utility functions exist to convert a user-specified `git_buf` to a
  `git_str` so that we can call internal functions, then converting it
  back again.
  

Download

• src/transports/auth.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_transports_auth_h__
  #define INCLUDE_transports_auth_h__
  
  #include "common.h"
  
  #include "netops.h"
  
  typedef enum {
  	GIT_HTTP_AUTH_BASIC = 1,
  	GIT_HTTP_AUTH_NEGOTIATE = 2,
  	GIT_HTTP_AUTH_NTLM = 4,
  } git_http_auth_t;
  
  typedef struct git_http_auth_context git_http_auth_context;
  
  struct git_http_auth_context {
  	/** Type of scheme */
  	git_http_auth_t type;
  
  	/** Supported credentials */
  	git_credential_t credtypes;
  
  	/** Connection affinity or request affinity */
  	unsigned connection_affinity : 1;
  
  	/** Sets the challenge on the authentication context */
  	int (*set_challenge)(git_http_auth_context *ctx, const char *challenge);
  
  	/** Gets the next authentication token from the context */
  	int (*next_token)(git_str *out, git_http_auth_context *ctx, git_credential *cred);
  
  	/** Examines if all tokens have been presented. */
  	int (*is_complete)(git_http_auth_context *ctx);
  
  	/** Frees the authentication context */
  	void (*free)(git_http_auth_context *ctx);
  };
  
  typedef struct {
  	/** Type of scheme */
  	git_http_auth_t type;
  
  	/** Name of the scheme (as used in the Authorization header) */
  	const char *name;
  
  	/** Credential types this scheme supports */
  	git_credential_t credtypes;
  
  	/** Function to initialize an authentication context */
  	int (*init_context)(
  		git_http_auth_context **out,
  		const git_net_url *url);
  } git_http_auth_scheme;
  
  int git_http_auth_dummy(
  	git_http_auth_context **out,
  	const git_net_url *url);
  
  int git_http_auth_basic(
  	git_http_auth_context **out,
  	const git_net_url *url);
  
  #endif
  

Download