generated.proto 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. /*
  2. Copyright 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. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = "proto2";
  15. package k8s.io.api.authentication.v1beta1;
  16. import "k8s.io/api/authentication/v1/generated.proto";
  17. import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  18. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  19. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  20. // Package-wide variables from generator "generated".
  21. option go_package = "k8s.io/api/authentication/v1beta1";
  22. // ExtraValue masks the value so protobuf can generate
  23. // +protobuf.nullable=true
  24. // +protobuf.options.(gogoproto.goproto_stringer)=false
  25. message ExtraValue {
  26. // items, if empty, will result in an empty slice
  27. repeated string items = 1;
  28. }
  29. // SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request.
  30. // When using impersonation, users will receive the user info of the user being impersonated. If impersonation or
  31. // request header authentication is used, any extra keys will have their case ignored and returned as lowercase.
  32. message SelfSubjectReview {
  33. // Standard object's metadata.
  34. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  35. // +optional
  36. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  37. // Status is filled in by the server with the user attributes.
  38. optional SelfSubjectReviewStatus status = 2;
  39. }
  40. // SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.
  41. message SelfSubjectReviewStatus {
  42. // User attributes of the user making this request.
  43. // +optional
  44. optional k8s.io.api.authentication.v1.UserInfo userInfo = 1;
  45. }
  46. // TokenReview attempts to authenticate a token to a known user.
  47. // Note: TokenReview requests may be cached by the webhook token authenticator
  48. // plugin in the kube-apiserver.
  49. message TokenReview {
  50. // Standard object's metadata.
  51. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  52. // +optional
  53. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  54. // Spec holds information about the request being evaluated
  55. optional TokenReviewSpec spec = 2;
  56. // Status is filled in by the server and indicates whether the token can be authenticated.
  57. // +optional
  58. optional TokenReviewStatus status = 3;
  59. }
  60. // TokenReviewSpec is a description of the token authentication request.
  61. message TokenReviewSpec {
  62. // Token is the opaque bearer token.
  63. // +optional
  64. optional string token = 1;
  65. // Audiences is a list of the identifiers that the resource server presented
  66. // with the token identifies as. Audience-aware token authenticators will
  67. // verify that the token was intended for at least one of the audiences in
  68. // this list. If no audiences are provided, the audience will default to the
  69. // audience of the Kubernetes apiserver.
  70. // +optional
  71. repeated string audiences = 2;
  72. }
  73. // TokenReviewStatus is the result of the token authentication request.
  74. message TokenReviewStatus {
  75. // Authenticated indicates that the token was associated with a known user.
  76. // +optional
  77. optional bool authenticated = 1;
  78. // User is the UserInfo associated with the provided token.
  79. // +optional
  80. optional UserInfo user = 2;
  81. // Audiences are audience identifiers chosen by the authenticator that are
  82. // compatible with both the TokenReview and token. An identifier is any
  83. // identifier in the intersection of the TokenReviewSpec audiences and the
  84. // token's audiences. A client of the TokenReview API that sets the
  85. // spec.audiences field should validate that a compatible audience identifier
  86. // is returned in the status.audiences field to ensure that the TokenReview
  87. // server is audience aware. If a TokenReview returns an empty
  88. // status.audience field where status.authenticated is "true", the token is
  89. // valid against the audience of the Kubernetes API server.
  90. // +optional
  91. repeated string audiences = 4;
  92. // Error indicates that the token couldn't be checked
  93. // +optional
  94. optional string error = 3;
  95. }
  96. // UserInfo holds the information about the user needed to implement the
  97. // user.Info interface.
  98. message UserInfo {
  99. // The name that uniquely identifies this user among all active users.
  100. // +optional
  101. optional string username = 1;
  102. // A unique value that identifies this user across time. If this user is
  103. // deleted and another user by the same name is added, they will have
  104. // different UIDs.
  105. // +optional
  106. optional string uid = 2;
  107. // The names of groups this user is a part of.
  108. // +optional
  109. repeated string groups = 3;
  110. // Any additional information provided by the authenticator.
  111. // +optional
  112. map<string, ExtraValue> extra = 4;
  113. }