1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
package lfsapi
import (
"encoding/base64"
"fmt"
"net/http"
"net/url"
"os"
"strings"
"github.com/git-lfs/git-lfs/v3/creds"
"github.com/git-lfs/git-lfs/v3/errors"
"github.com/git-lfs/git-lfs/v3/lfshttp"
"github.com/git-lfs/git-lfs/v3/tr"
"github.com/rubyist/tracerx"
)
var (
defaultEndpointFinder = NewEndpointFinder(nil)
defaultMaxAuthAttempts = 3
)
// DoWithAuth sends an HTTP request to get an HTTP response. It attempts to add
// authentication from netrc or git's credential helpers if necessary,
// supporting basic authentication.
func (c *Client) DoWithAuth(remote string, access creds.Access, req *http.Request) (*http.Response, error) {
count := 0
res, err := c.doWithAuth(remote, &count, access, req, nil)
if errors.IsAuthError(err) {
if len(req.Header.Get("Authorization")) == 0 {
// This case represents a rejected request that
// should have been authenticated but wasn't. Do
// not count this against our redirection
// maximum.
newAccess := c.Endpoints.AccessFor(access.URL())
tracerx.Printf("api: http response indicates %q authentication. Resubmitting...", newAccess.Mode())
return c.DoWithAuth(remote, newAccess, req)
}
}
return res, err
}
// DoWithAuthNoRetry sends an HTTP request to get an HTTP response. It works in
// the same way as DoWithAuth, but will not retry the request if it fails with
// an authorization error.
func (c *Client) DoWithAuthNoRetry(remote string, access creds.Access, req *http.Request) (*http.Response, error) {
count := 0
return c.doWithAuth(remote, &count, access, req, nil)
}
// DoAPIRequestWithAuth sends an HTTP request to get an HTTP response similarly
// to DoWithAuth, but using the LFS API endpoint for the provided remote and
// operation to determine the access mode.
func (c *Client) DoAPIRequestWithAuth(remote string, req *http.Request) (*http.Response, error) {
operation := getReqOperation(req)
apiEndpoint := c.Endpoints.Endpoint(operation, remote)
access := c.Endpoints.AccessFor(apiEndpoint.Url)
return c.DoWithAuth(remote, access, req)
}
func (c *Client) doWithAuth(remote string, count *int, access creds.Access, req *http.Request, via []*http.Request) (*http.Response, error) {
if *count == defaultMaxAuthAttempts {
return nil, fmt.Errorf("too many authentication attempts")
}
req.Header = c.client.ExtraHeadersFor(req)
credWrapper, err := c.getCreds(remote, access, req)
if err != nil {
return nil, err
}
c.credContext.SetStateFields(credWrapper.Creds["state[]"])
res, err := c.doWithCreds(req, count, credWrapper, access, via)
if err != nil {
if errors.IsAuthError(err) {
multistage := credWrapper.Creds.IsMultistage()
newMode, newModes, headers := getAuthAccess(res, access.Mode(), c.access, multistage)
newAccess := access.Upgrade(newMode)
if newAccess.Mode() != access.Mode() {
c.Endpoints.SetAccess(newAccess)
c.access = newModes
}
if credWrapper.Creds != nil {
req.Header.Del("Authorization")
if multistage && *count < defaultMaxAuthAttempts && res != nil && res.StatusCode == 401 {
*count++
} else {
credWrapper.CredentialHelper.Reject(credWrapper.Creds)
}
}
c.credContext.SetWWWAuthHeaders(headers)
}
}
if res != nil && res.StatusCode < 300 && res.StatusCode > 199 {
credWrapper.CredentialHelper.Approve(credWrapper.Creds)
}
return res, err
}
func (c *Client) doWithCreds(req *http.Request, count *int, credWrapper creds.CredentialHelperWrapper, access creds.Access, via []*http.Request) (*http.Response, error) {
if access.Mode() == creds.NegotiateAccess {
return c.doWithNegotiate(req, credWrapper)
}
req.Header.Set("User-Agent", lfshttp.UserAgent)
client, err := c.client.HttpClient(req.URL, access.Mode())
if err != nil {
return nil, err
}
redirectedReq, res, err := c.client.DoWithRedirect(client, req, "", via)
if err != nil || res != nil {
return res, err
}
if redirectedReq == nil {
return res, errors.New(tr.Tr.Get("failed to redirect request"))
}
return c.doWithAuth("", count, access, redirectedReq, via)
}
// getCreds fills the authorization header for the given request if possible,
// from the following sources:
//
// 1. NTLM access is handled elsewhere.
// 2. Existing Authorization or ?token query tells LFS that the request is ready.
// 3. Netrc based on the hostname.
// 4. URL authentication on the Endpoint URL or the Git Remote URL.
// 5. Git Credential Helper, potentially prompting the user.
//
// There are three URLs in play, that make this a little confusing.
//
// 1. The request URL, which should be something like "https://git.com/repo.git/info/lfs/objects/batch"
// 2. The LFS API URL, which should be something like "https://git.com/repo.git/info/lfs"
// This URL used for the "lfs.URL.access" git config key, which determines
// what kind of auth the LFS server expects. Could be BasicAccess,
// NTLMAccess, NegotiateAccess, or NoneAccess, in which the Git Credential
// Helper step is skipped. We do not want to prompt the user for a password
// to fetch public repository data.
// 3. The Git Remote URL, which should be something like "https://git.com/repo.git"
// This URL is used for the Git Credential Helper. This way existing https
// Git remote credentials can be re-used for LFS.
func (c *Client) getCreds(remote string, access creds.Access, req *http.Request) (creds.CredentialHelperWrapper, error) {
ef := c.Endpoints
if ef == nil {
ef = defaultEndpointFinder
}
operation := getReqOperation(req)
apiEndpoint := ef.Endpoint(operation, remote)
if access.Mode() != creds.NegotiateAccess {
if requestHasAuth(req) || access.Mode() == creds.NoneAccess {
return creds.CredentialHelperWrapper{CredentialHelper: creds.NullCreds, Input: nil, Url: nil, Creds: nil}, nil
}
credsURL, err := getCredURLForAPI(ef, operation, remote, apiEndpoint, req)
if err != nil {
return creds.CredentialHelperWrapper{CredentialHelper: creds.NullCreds, Input: nil, Url: nil, Creds: nil}, errors.Wrap(err, tr.Tr.Get("credentials"))
}
if credsURL == nil {
return creds.CredentialHelperWrapper{CredentialHelper: creds.NullCreds, Input: nil, Url: nil, Creds: nil}, nil
}
credWrapper := c.getGitCredsWrapper(ef, req, credsURL)
err = credWrapper.FillCreds()
if err == nil {
tracerx.Printf("Filled credentials for %s", credsURL)
setRequestAuthWithCreds(req, credWrapper.Creds)
}
return credWrapper, err
}
// Negotiate only
credsURL, err := url.Parse(apiEndpoint.Url)
if err != nil {
return creds.CredentialHelperWrapper{CredentialHelper: creds.NullCreds, Input: nil, Url: nil, Creds: nil}, errors.Wrap(err, tr.Tr.Get("credentials"))
}
// NTLM uses creds to create the session
credWrapper := c.getGitCredsWrapper(ef, req, credsURL)
return credWrapper, err
}
func (c *Client) getGitCredsWrapper(ef EndpointFinder, req *http.Request, u *url.URL) creds.CredentialHelperWrapper {
return c.credContext.GetCredentialHelper(c.Credentials, u)
}
func getCredURLForAPI(ef EndpointFinder, operation, remote string, apiEndpoint lfshttp.Endpoint, req *http.Request) (*url.URL, error) {
apiURL, err := url.Parse(apiEndpoint.Url)
if err != nil {
return nil, err
}
// if the LFS request doesn't match the current LFS url, don't bother
// attempting to set the Authorization header from the LFS or Git remote URLs.
if req.URL.Scheme != apiURL.Scheme ||
req.URL.Host != apiURL.Host {
return req.URL, nil
}
if setRequestAuthFromURL(req, apiURL) {
return nil, nil
}
if len(remote) > 0 {
if u := ef.GitRemoteURL(remote, operation == "upload"); u != "" {
schemedUrl, _ := fixSchemelessURL(u)
gitRemoteURL, err := url.Parse(schemedUrl)
if err != nil {
return nil, err
}
if gitRemoteURL.Scheme == apiURL.Scheme &&
gitRemoteURL.Host == apiURL.Host {
if setRequestAuthFromURL(req, gitRemoteURL) {
return nil, nil
}
return gitRemoteURL, nil
}
}
}
return apiURL, nil
}
// fixSchemelessURL prepends an empty scheme "//" if none was found in
// the URL and replaces the first colon with a slash in order to satisfy RFC
// 3986 §3.3, and `net/url.Parse()`.
//
// It returns a string parse-able with `net/url.Parse()` and a boolean whether
// or not an empty scheme was added.
func fixSchemelessURL(u string) (string, bool) {
if hasScheme(u) {
return u, false
}
colon := strings.Index(u, ":")
slash := strings.Index(u, "/")
if colon >= 0 && (slash < 0 || colon < slash) {
// First path segment has a colon, assumed that it's a
// scheme-less URL. Append an empty scheme on top to
// satisfy RFC 3986 §3.3, and `net/url.Parse()`.
//
// In addition, replace the first colon with a slash since
// otherwise the colon looks like it's introducing a port
// number.
return fmt.Sprintf("//%s", strings.Replace(u, ":", "/", 1)), true
}
return u, true
}
var (
// supportedSchemes is the list of URL schemes the `lfsapi` package
// supports.
supportedSchemes = []string{"ssh", "http", "https"}
)
// hasScheme returns whether or not a given string (taken to represent a RFC
// 3986 URL) has a scheme that is supported by the `lfsapi` package.
func hasScheme(what string) bool {
for _, scheme := range supportedSchemes {
if strings.HasPrefix(what, fmt.Sprintf("%s://", scheme)) {
return true
}
}
return false
}
func requestHasAuth(req *http.Request) bool {
// The "Authorization" string constant is safe, since we assume that all
// request headers have been canonicalized.
if len(req.Header.Get("Authorization")) > 0 {
return true
}
return len(req.URL.Query().Get("token")) > 0
}
func setRequestAuthFromURL(req *http.Request, u *url.URL) bool {
if u.User == nil {
return false
}
if pass, ok := u.User.Password(); ok {
fmt.Fprintln(os.Stderr, tr.Tr.Get("warning: current Git remote contains credentials"))
setRequestAuth(req, u.User.Username(), pass)
return true
}
return false
}
func setRequestAuth(req *http.Request, user, pass string) {
if len(user) == 0 && len(pass) == 0 {
return
}
token := fmt.Sprintf("%s:%s", user, pass)
auth := "Basic " + strings.TrimSpace(base64.StdEncoding.EncodeToString([]byte(token)))
req.Header.Set("Authorization", auth)
}
func setRequestAuthWithCreds(req *http.Request, c creds.Creds) {
authtype := creds.FirstEntryForKey(c, "authtype")
credential := creds.FirstEntryForKey(c, "credential")
if len(authtype) == 0 && len(credential) == 0 {
user := creds.FirstEntryForKey(c, "username")
pass := creds.FirstEntryForKey(c, "password")
setRequestAuth(req, user, pass)
return
}
auth := fmt.Sprintf("%s %s", authtype, credential)
req.Header.Set("Authorization", auth)
}
func getReqOperation(req *http.Request) string {
operation := "download"
if req.Method == "POST" || req.Method == "PUT" {
operation = "upload"
}
return operation
}
var (
authenticateHeaders = []string{"Lfs-Authenticate", "Www-Authenticate"}
)
func getAuthAccess(res *http.Response, access creds.AccessMode, modes []creds.AccessMode, multistage bool) (creds.AccessMode, []creds.AccessMode, []string) {
newModes := make([]creds.AccessMode, 0, len(modes))
for _, mode := range modes {
if multistage || access != mode {
newModes = append(newModes, mode)
}
}
headers := make([]string, 0)
if res != nil {
for _, headerName := range authenticateHeaders {
headers = append(headers, res.Header[headerName]...)
}
supportedModes := make(map[creds.AccessMode]struct{})
for _, headerName := range authenticateHeaders {
for _, auth := range res.Header[headerName] {
pieces := strings.SplitN(strings.ToLower(auth), " ", 2)
if len(pieces) == 0 {
continue
}
supportedModes[creds.AccessMode(pieces[0])] = struct{}{}
}
}
for _, mode := range newModes {
if _, ok := supportedModes[mode]; ok {
return mode, newModes, headers
}
}
}
return creds.BasicAccess, newModes, headers
}
|