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
|
package api
import (
"fmt"
"io"
"net"
"net/http"
"os"
"regexp"
"runtime/debug"
"strings"
"time"
"github.com/cli/go-gh/v2/pkg/asciisanitizer"
"github.com/cli/go-gh/v2/pkg/config"
"github.com/cli/go-gh/v2/pkg/term"
"github.com/henvic/httpretty"
"github.com/thlib/go-timezone-local/tzlocal"
"golang.org/x/text/transform"
)
const (
accept = "Accept"
authorization = "Authorization"
contentType = "Content-Type"
github = "github.com"
jsonContentType = "application/json; charset=utf-8"
localhost = "github.localhost"
modulePath = "github.com/cli/go-gh"
timeZone = "Time-Zone"
userAgent = "User-Agent"
)
var jsonTypeRE = regexp.MustCompile(`[/+]json($|;)`)
func DefaultHTTPClient() (*http.Client, error) {
return NewHTTPClient(ClientOptions{})
}
// HTTPClient builds a client that can be passed to another library.
// As part of the configuration a hostname, auth token, default set of headers,
// and unix domain socket are resolved from the gh environment configuration.
// These behaviors can be overridden using the opts argument. In this instance
// providing opts.Host will not change the destination of your request as it is
// the responsibility of the consumer to configure this. However, if opts.Host
// does not match the request host, the auth token will not be added to the headers.
// This is to protect against the case where tokens could be sent to an arbitrary
// host.
func NewHTTPClient(opts ClientOptions) (*http.Client, error) {
if optionsNeedResolution(opts) {
var err error
opts, err = resolveOptions(opts)
if err != nil {
return nil, err
}
}
transport := http.DefaultTransport
if opts.UnixDomainSocket != "" {
transport = newUnixDomainSocketRoundTripper(opts.UnixDomainSocket)
}
if opts.Transport != nil {
transport = opts.Transport
}
transport = newSanitizerRoundTripper(transport)
if opts.CacheDir == "" {
opts.CacheDir = config.CacheDir()
}
if opts.EnableCache && opts.CacheTTL == 0 {
opts.CacheTTL = time.Hour * 24
}
c := cache{dir: opts.CacheDir, ttl: opts.CacheTTL}
transport = c.RoundTripper(transport)
if opts.Log == nil && !opts.LogIgnoreEnv {
ghDebug := os.Getenv("GH_DEBUG")
switch ghDebug {
case "", "0", "false", "no":
// no logging
default:
opts.Log = os.Stderr
opts.LogColorize = !term.IsColorDisabled() && term.IsTerminal(os.Stderr)
opts.LogVerboseHTTP = strings.Contains(ghDebug, "api")
}
}
if opts.Log != nil {
logger := &httpretty.Logger{
Time: true,
TLS: false,
Colors: opts.LogColorize,
RequestHeader: opts.LogVerboseHTTP,
RequestBody: opts.LogVerboseHTTP,
ResponseHeader: opts.LogVerboseHTTP,
ResponseBody: opts.LogVerboseHTTP,
Formatters: []httpretty.Formatter{&jsonFormatter{colorize: opts.LogColorize}},
MaxResponseBody: 100000,
}
logger.SetOutput(opts.Log)
logger.SetBodyFilter(func(h http.Header) (skip bool, err error) {
return !inspectableMIMEType(h.Get(contentType)), nil
})
transport = logger.RoundTripper(transport)
}
if opts.Headers == nil {
opts.Headers = map[string]string{}
}
if !opts.SkipDefaultHeaders {
resolveHeaders(opts.Headers)
}
transport = newHeaderRoundTripper(opts.Host, opts.AuthToken, opts.Headers, transport)
return &http.Client{Transport: transport, Timeout: opts.Timeout}, nil
}
func inspectableMIMEType(t string) bool {
return strings.HasPrefix(t, "text/") ||
strings.HasPrefix(t, "application/x-www-form-urlencoded") ||
jsonTypeRE.MatchString(t)
}
func isSameDomain(requestHost, domain string) bool {
requestHost = strings.ToLower(requestHost)
domain = strings.ToLower(domain)
return (requestHost == domain) || strings.HasSuffix(requestHost, "."+domain)
}
func isGarage(host string) bool {
return strings.EqualFold(host, "garage.github.com")
}
func isEnterprise(host string) bool {
return host != github && host != localhost
}
func normalizeHostname(hostname string) string {
hostname = strings.ToLower(hostname)
if strings.HasSuffix(hostname, "."+github) {
return github
}
if strings.HasSuffix(hostname, "."+localhost) {
return localhost
}
return hostname
}
type headerRoundTripper struct {
headers map[string]string
host string
rt http.RoundTripper
}
func resolveHeaders(headers map[string]string) {
if _, ok := headers[contentType]; !ok {
headers[contentType] = jsonContentType
}
if _, ok := headers[userAgent]; !ok {
headers[userAgent] = "go-gh"
info, ok := debug.ReadBuildInfo()
if ok {
for _, dep := range info.Deps {
if dep.Path == modulePath {
headers[userAgent] += fmt.Sprintf(" %s", dep.Version)
break
}
}
}
}
if _, ok := headers[timeZone]; !ok {
tz := currentTimeZone()
if tz != "" {
headers[timeZone] = tz
}
}
if _, ok := headers[accept]; !ok {
// Preview for PullRequest.mergeStateStatus.
a := "application/vnd.github.merge-info-preview+json"
// Preview for visibility when RESTing repos into an org.
a += ", application/vnd.github.nebula-preview"
headers[accept] = a
}
}
func newHeaderRoundTripper(host string, authToken string, headers map[string]string, rt http.RoundTripper) http.RoundTripper {
if _, ok := headers[authorization]; !ok && authToken != "" {
headers[authorization] = fmt.Sprintf("token %s", authToken)
}
if len(headers) == 0 {
return rt
}
return headerRoundTripper{host: host, headers: headers, rt: rt}
}
func (hrt headerRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
for k, v := range hrt.headers {
// If the authorization header has been set and the request
// host is not in the same domain that was specified in the ClientOptions
// then do not add the authorization header to the request.
if k == authorization && !isSameDomain(req.URL.Hostname(), hrt.host) {
continue
}
// If the header is already set in the request, don't overwrite it.
if req.Header.Get(k) == "" {
req.Header.Set(k, v)
}
}
return hrt.rt.RoundTrip(req)
}
func newUnixDomainSocketRoundTripper(socketPath string) http.RoundTripper {
dial := func(network, addr string) (net.Conn, error) {
return net.Dial("unix", socketPath)
}
return &http.Transport{
Dial: dial,
DialTLS: dial,
DisableKeepAlives: true,
}
}
type sanitizerRoundTripper struct {
rt http.RoundTripper
}
func newSanitizerRoundTripper(rt http.RoundTripper) http.RoundTripper {
return sanitizerRoundTripper{rt: rt}
}
func (srt sanitizerRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
resp, err := srt.rt.RoundTrip(req)
if err != nil || !jsonTypeRE.MatchString(resp.Header.Get(contentType)) {
return resp, err
}
sanitizedReadCloser := struct {
io.Reader
io.Closer
}{
Reader: transform.NewReader(resp.Body, &asciisanitizer.Sanitizer{JSON: true}),
Closer: resp.Body,
}
resp.Body = sanitizedReadCloser
return resp, err
}
func currentTimeZone() string {
tz, err := tzlocal.RuntimeTZ()
if err != nil {
return ""
}
return tz
}
|