useragent.go 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. package dockerversion // import "github.com/docker/docker/dockerversion"
  2. import (
  3. "context"
  4. "fmt"
  5. "runtime"
  6. "sync"
  7. "github.com/docker/docker/pkg/parsers/kernel"
  8. "github.com/docker/docker/pkg/useragent"
  9. )
  10. // UAStringKey is used as key type for user-agent string in net/context struct
  11. type UAStringKey struct{}
  12. // DockerUserAgent is the User-Agent the Docker client uses to identify itself.
  13. // In accordance with RFC 7231 (5.5.3) is of the form:
  14. //
  15. // [docker client's UA] UpstreamClient([upstream client's UA])
  16. func DockerUserAgent(ctx context.Context, extraVersions ...useragent.VersionInfo) string {
  17. ua := useragent.AppendVersions(getDaemonUserAgent(), extraVersions...)
  18. if upstreamUA := getUpstreamUserAgent(ctx); upstreamUA != "" {
  19. ua += " " + upstreamUA
  20. }
  21. return ua
  22. }
  23. var (
  24. daemonUAOnce sync.Once
  25. daemonUA string
  26. )
  27. // getDaemonUserAgent returns the user-agent to use for requests made by
  28. // the daemon.
  29. //
  30. // It includes;
  31. //
  32. // - the docker version
  33. // - go version
  34. // - git-commit
  35. // - kernel version
  36. // - os
  37. // - architecture
  38. func getDaemonUserAgent() string {
  39. daemonUAOnce.Do(func() {
  40. httpVersion := make([]useragent.VersionInfo, 0, 6)
  41. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "docker", Version: Version})
  42. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "go", Version: runtime.Version()})
  43. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "git-commit", Version: GitCommit})
  44. if kernelVersion, err := kernel.GetKernelVersion(); err == nil {
  45. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "kernel", Version: kernelVersion.String()})
  46. }
  47. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "os", Version: runtime.GOOS})
  48. httpVersion = append(httpVersion, useragent.VersionInfo{Name: "arch", Version: runtime.GOARCH})
  49. daemonUA = useragent.AppendVersions("", httpVersion...)
  50. })
  51. return daemonUA
  52. }
  53. // getUpstreamUserAgent returns the previously saved user-agent context stored
  54. // in ctx, if one exists, and formats it as:
  55. //
  56. // UpstreamClient(<upstream user agent string>)
  57. //
  58. // It returns an empty string if no user-agent is present in the context.
  59. func getUpstreamUserAgent(ctx context.Context) string {
  60. var upstreamUA string
  61. if ctx != nil {
  62. if ki := ctx.Value(UAStringKey{}); ki != nil {
  63. upstreamUA = ctx.Value(UAStringKey{}).(string)
  64. }
  65. }
  66. if upstreamUA == "" {
  67. return ""
  68. }
  69. return fmt.Sprintf("UpstreamClient(%s)", escapeStr(upstreamUA))
  70. }
  71. const charsToEscape = `();\`
  72. // escapeStr returns s with every rune in charsToEscape escaped by a backslash
  73. func escapeStr(s string) string {
  74. var ret string
  75. for _, currRune := range s {
  76. appended := false
  77. for _, escapableRune := range charsToEscape {
  78. if currRune == escapableRune {
  79. ret += `\` + string(currRune)
  80. appended = true
  81. break
  82. }
  83. }
  84. if !appended {
  85. ret += string(currRune)
  86. }
  87. }
  88. return ret
  89. }