check_metadata_concealment.go 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. /*
  2. Copyright 2017 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package main
  14. import (
  15. "fmt"
  16. "io/ioutil"
  17. "log"
  18. "net/http"
  19. "os"
  20. "regexp"
  21. )
  22. var (
  23. successEndpoints = []string{
  24. // Discovery
  25. "http://169.254.169.254",
  26. "http://metadata.google.internal",
  27. "http://169.254.169.254/",
  28. "http://metadata.google.internal/",
  29. "http://metadata.google.internal/0.1",
  30. "http://metadata.google.internal/0.1/",
  31. "http://metadata.google.internal/computeMetadata",
  32. "http://metadata.google.internal/computeMetadata/v1",
  33. // Allowed API versions.
  34. "http://metadata.google.internal/computeMetadata/v1/",
  35. // Service account token endpoints.
  36. "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/token",
  37. // Permitted recursive query to SA endpoint.
  38. "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/?recursive=true",
  39. // Known query params.
  40. "http://metadata.google.internal/computeMetadata/v1/instance/tags?alt=text",
  41. "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=false",
  42. "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true&timeout_sec=0",
  43. "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true&last_etag=d34db33f",
  44. }
  45. legacySuccessEndpoints = []string{
  46. // Discovery
  47. "http://metadata.google.internal/0.1/meta-data",
  48. "http://metadata.google.internal/computeMetadata/v1beta1",
  49. // Allowed API versions.
  50. "http://metadata.google.internal/0.1/meta-data/",
  51. "http://metadata.google.internal/computeMetadata/v1beta1/",
  52. // Service account token endpoints.
  53. "http://metadata.google.internal/0.1/meta-data/service-accounts/default/acquire",
  54. "http://metadata.google.internal/computeMetadata/v1beta1/instance/service-accounts/default/token",
  55. // Known query params.
  56. "http://metadata.google.internal/0.1/meta-data/service-accounts/default/acquire?scopes",
  57. }
  58. noKubeEnvEndpoints = []string{
  59. // Check that these don't get a recursive result.
  60. "http://metadata.google.internal/computeMetadata/v1/instance/?recursive%3Dtrue", // urlencoded
  61. "http://metadata.google.internal/computeMetadata/v1/instance/?re%08ecursive=true", // backspaced
  62. }
  63. failureEndpoints = []string{
  64. // Other API versions.
  65. "http://metadata.google.internal/0.2/",
  66. "http://metadata.google.internal/computeMetadata/v2/",
  67. // kube-env.
  68. "http://metadata.google.internal/0.1/meta-data/attributes/kube-env",
  69. "http://metadata.google.internal/computeMetadata/v1beta1/instance/attributes/kube-env",
  70. "http://metadata.google.internal/computeMetadata/v1/instance/attributes/kube-env",
  71. // VM identity.
  72. "http://metadata.google.internal/0.1/meta-data/service-accounts/default/identity",
  73. "http://metadata.google.internal/computeMetadata/v1beta1/instance/service-accounts/default/identity",
  74. "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity",
  75. // Forbidden recursive queries.
  76. "http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true",
  77. "http://metadata.google.internal/computeMetadata/v1/instance/?%72%65%63%75%72%73%69%76%65=true", // url-encoded
  78. // Unknown query param key.
  79. "http://metadata.google.internal/computeMetadata/v1/instance/?something=else",
  80. "http://metadata.google.internal/computeMetadata/v1/instance/?unknown",
  81. // Other.
  82. "http://metadata.google.internal/computeMetadata/v1/instance/attributes//kube-env",
  83. "http://metadata.google.internal/computeMetadata/v1/instance/attributes/../attributes/kube-env",
  84. "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts//default/identity",
  85. "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/../service-accounts/default/identity",
  86. }
  87. )
  88. func main() {
  89. success := 0
  90. h := map[string][]string{
  91. "Metadata-Flavor": {"Google"},
  92. }
  93. for _, e := range successEndpoints {
  94. if err := checkURL(e, h, 200, "", ""); err != nil {
  95. log.Printf("Wrong response for %v: %v", e, err)
  96. success = 1
  97. }
  98. }
  99. for _, e := range noKubeEnvEndpoints {
  100. if err := checkURL(e, h, 403, "", "kube-env"); err != nil {
  101. log.Printf("Wrong response for %v: %v", e, err)
  102. success = 1
  103. }
  104. }
  105. for _, e := range failureEndpoints {
  106. if err := checkURL(e, h, 403, "", ""); err != nil {
  107. log.Printf("Wrong response for %v: %v", e, err)
  108. success = 1
  109. }
  110. }
  111. legacyEndpointExpectedStatus := 200
  112. if err := checkURL("http://metadata.google.internal/computeMetadata/v1/instance/attributes/disable-legacy-endpoints", h, 200, "true", ""); err == nil {
  113. // If `disable-legacy-endpoints` is set to true, queries to unconcealed legacy endpoints will return a 403.
  114. legacyEndpointExpectedStatus = 403
  115. }
  116. for _, e := range legacySuccessEndpoints {
  117. if err := checkURL(e, h, legacyEndpointExpectedStatus, "", ""); err != nil {
  118. log.Printf("Wrong response for %v: %v", e, err)
  119. success = 1
  120. }
  121. }
  122. xForwardedForHeader := map[string][]string{
  123. "X-Forwarded-For": {"Somebody-somewhere"},
  124. }
  125. // Check that success endpoints fail if X-Forwarded-For is present.
  126. for _, e := range successEndpoints {
  127. if err := checkURL(e, xForwardedForHeader, 403, "", ""); err != nil {
  128. log.Printf("Wrong response for %v with X-Forwarded-For: %v", e, err)
  129. success = 1
  130. }
  131. }
  132. os.Exit(success)
  133. }
  134. // Checks that a URL with the given headers returns the right code.
  135. // If expectedToContain is non-empty, checks that the body contains expectedToContain.
  136. // Similarly, if expectedToNotContain is non-empty, checks that the body doesn't contain expectedToNotContain.
  137. func checkURL(url string, header http.Header, expectedStatus int, expectedToContain, expectedToNotContain string) error {
  138. client := &http.Client{}
  139. req, err := http.NewRequest("GET", url, nil)
  140. if err != nil {
  141. return err
  142. }
  143. req.Header = header
  144. resp, err := client.Do(req)
  145. if err != nil {
  146. return err
  147. }
  148. defer resp.Body.Close()
  149. if resp.StatusCode != expectedStatus {
  150. return fmt.Errorf("unexpected response: got %d, want %d", resp.StatusCode, expectedStatus)
  151. }
  152. body, err := ioutil.ReadAll(resp.Body)
  153. if err != nil {
  154. return err
  155. }
  156. if expectedToContain != "" {
  157. matched, err := regexp.Match(expectedToContain, body)
  158. if err != nil {
  159. return err
  160. }
  161. if !matched {
  162. return fmt.Errorf("body didn't contain %q: got %v", expectedToContain, string(body))
  163. }
  164. }
  165. if expectedToNotContain != "" {
  166. matched, err := regexp.Match(expectedToNotContain, body)
  167. if err != nil {
  168. return err
  169. }
  170. if matched {
  171. return fmt.Errorf("body incorrectly contained %q: got %v", expectedToNotContain, string(body))
  172. }
  173. }
  174. return nil
  175. }