thodg/libgit2/src/transports/credential_helpers.c

• Show log

  Commit

• Hash : c6184f0c
  Author :
  Date : 2020-06-08T21:07:36
  

  tree-wide: do not compile deprecated functions with hard deprecation When compiling libgit2 with -DDEPRECATE_HARD, we add a preprocessor definition `GIT_DEPRECATE_HARD` which causes the "git2/deprecated.h" header to be empty. As a result, no function declarations are made available to callers, but the implementations are still available to link against. This has the problem that function declarations also aren't visible to the implementations, meaning that the symbol's visibility will not be set up correctly. As a result, the resulting library may not expose those deprecated symbols at all on some platforms and thus cause linking errors. Fix the issue by conditionally compiling deprecated functions, only. While it becomes impossible to link against such a library in case one uses deprecated functions, distributors of libgit2 aren't expected to pass -DDEPRECATE_HARD anyway. Instead, users of libgit2 should manually define GIT_DEPRECATE_HARD to hide deprecated functions. Using "real" hard deprecation still makes sense in the context of CI to test we don't use deprecated symbols ourselves and in case a dependant uses libgit2 in a vendored way and knows it won't ever use any of the deprecated symbols anyway.

Download

• src/transports/credential_helpers.c

• /*
   * 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.
   */
  
  #include "common.h"
  
  #include "git2/credential_helpers.h"
  
  int git_credential_userpass(
  		git_credential **cred,
  		const char *url,
  		const char *user_from_url,
  		unsigned int allowed_types,
  		void *payload)
  {
  	git_credential_userpass_payload *userpass = (git_credential_userpass_payload*)payload;
  	const char *effective_username = NULL;
  
  	GIT_UNUSED(url);
  
  	if (!userpass || !userpass->password) return -1;
  
  	/* Username resolution: a username can be passed with the URL, the
  	 * credentials payload, or both. Here's what we do.  Note that if we get
  	 * this far, we know that any password the url may contain has already
  	 * failed at least once, so we ignore it.
  	 *
  	 * |  Payload    |   URL    |   Used    |
  	 * +-------------+----------+-----------+
  	 * |    yes      |   no     |  payload  |
  	 * |    yes      |   yes    |  payload  |
  	 * |    no       |   yes    |  url      |
  	 * |    no       |   no     |  FAIL     |
  	 */
  	if (userpass->username)
  		effective_username = userpass->username;
  	else if (user_from_url)
  		effective_username = user_from_url;
  	else
  		return -1;
  
  	if (GIT_CREDENTIAL_USERNAME & allowed_types)
  		return git_credential_username_new(cred, effective_username);
  
  	if ((GIT_CREDENTIAL_USERPASS_PLAINTEXT & allowed_types) == 0 ||
  			git_credential_userpass_plaintext_new(cred, effective_username, userpass->password) < 0)
  		return -1;
  
  	return 0;
  }
  
  /* Deprecated credential functions */
  
  #ifndef GIT_DEPRECATE_HARD
  int git_cred_userpass(
  	git_credential **out,
  	const char *url,
  	const char *user_from_url,
  	unsigned int allowed_types,
  	void *payload)
  {
  	return git_credential_userpass(out, url, user_from_url,
  		allowed_types, payload);
  }
  #endif
  

Download