|
| 1 | +--- |
| 2 | +apiVersion: apiextensions.k8s.io/v1 |
| 3 | +kind: CustomResourceDefinition |
| 4 | +metadata: |
| 5 | + annotations: |
| 6 | + controller-gen.kubebuilder.io/version: v0.14.0 |
| 7 | + name: accesscontrolpolicies.hub.traefik.io |
| 8 | +spec: |
| 9 | + group: hub.traefik.io |
| 10 | + names: |
| 11 | + kind: AccessControlPolicy |
| 12 | + listKind: AccessControlPolicyList |
| 13 | + plural: accesscontrolpolicies |
| 14 | + singular: accesscontrolpolicy |
| 15 | + scope: Cluster |
| 16 | + versions: |
| 17 | + - name: v1alpha1 |
| 18 | + schema: |
| 19 | + openAPIV3Schema: |
| 20 | + description: AccessControlPolicy defines an access control policy. |
| 21 | + properties: |
| 22 | + apiVersion: |
| 23 | + description: |- |
| 24 | + APIVersion defines the versioned schema of this representation of an object. |
| 25 | + Servers should convert recognized schemas to the latest internal value, and |
| 26 | + may reject unrecognized values. |
| 27 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 28 | + type: string |
| 29 | + kind: |
| 30 | + description: |- |
| 31 | + Kind is a string value representing the REST resource this object represents. |
| 32 | + Servers may infer this from the endpoint the client submits requests to. |
| 33 | + Cannot be updated. |
| 34 | + In CamelCase. |
| 35 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 36 | + type: string |
| 37 | + metadata: |
| 38 | + type: object |
| 39 | + spec: |
| 40 | + description: AccessControlPolicySpec configures an access control policy. |
| 41 | + properties: |
| 42 | + apiKey: |
| 43 | + description: AccessControlPolicyAPIKey configure an APIKey control |
| 44 | + policy. |
| 45 | + properties: |
| 46 | + forwardHeaders: |
| 47 | + additionalProperties: |
| 48 | + type: string |
| 49 | + description: ForwardHeaders instructs the middleware to forward |
| 50 | + key metadata as header values upon successful authentication. |
| 51 | + type: object |
| 52 | + keySource: |
| 53 | + description: KeySource defines how to extract API keys from requests. |
| 54 | + properties: |
| 55 | + cookie: |
| 56 | + description: Cookie is the name of a cookie. |
| 57 | + type: string |
| 58 | + header: |
| 59 | + description: Header is the name of a header. |
| 60 | + type: string |
| 61 | + headerAuthScheme: |
| 62 | + description: |- |
| 63 | + HeaderAuthScheme sets an optional auth scheme when Header is set to "Authorization". |
| 64 | + If set, this scheme is removed from the token, and all requests not including it are dropped. |
| 65 | + type: string |
| 66 | + query: |
| 67 | + description: Query is the name of a query parameter. |
| 68 | + type: string |
| 69 | + type: object |
| 70 | + keys: |
| 71 | + description: Keys define the set of authorized keys to access |
| 72 | + a protected resource. |
| 73 | + items: |
| 74 | + description: AccessControlPolicyAPIKeyKey defines an API key. |
| 75 | + properties: |
| 76 | + id: |
| 77 | + description: ID is the unique identifier of the key. |
| 78 | + type: string |
| 79 | + metadata: |
| 80 | + additionalProperties: |
| 81 | + type: string |
| 82 | + description: Metadata holds arbitrary metadata for this |
| 83 | + key, can be used by ForwardHeaders. |
| 84 | + type: object |
| 85 | + value: |
| 86 | + description: Value is the SHAKE-256 hash (using 64 bytes) |
| 87 | + of the API key. |
| 88 | + type: string |
| 89 | + required: |
| 90 | + - id |
| 91 | + - value |
| 92 | + type: object |
| 93 | + type: array |
| 94 | + required: |
| 95 | + - keySource |
| 96 | + type: object |
| 97 | + basicAuth: |
| 98 | + description: AccessControlPolicyBasicAuth holds the HTTP basic authentication |
| 99 | + configuration. |
| 100 | + properties: |
| 101 | + forwardUsernameHeader: |
| 102 | + type: string |
| 103 | + realm: |
| 104 | + type: string |
| 105 | + stripAuthorizationHeader: |
| 106 | + type: boolean |
| 107 | + users: |
| 108 | + items: |
| 109 | + type: string |
| 110 | + type: array |
| 111 | + type: object |
| 112 | + jwt: |
| 113 | + description: AccessControlPolicyJWT configures a JWT access control |
| 114 | + policy. |
| 115 | + properties: |
| 116 | + claims: |
| 117 | + type: string |
| 118 | + forwardHeaders: |
| 119 | + additionalProperties: |
| 120 | + type: string |
| 121 | + type: object |
| 122 | + jwksFile: |
| 123 | + type: string |
| 124 | + jwksUrl: |
| 125 | + type: string |
| 126 | + publicKey: |
| 127 | + type: string |
| 128 | + signingSecret: |
| 129 | + type: string |
| 130 | + signingSecretBase64Encoded: |
| 131 | + type: boolean |
| 132 | + stripAuthorizationHeader: |
| 133 | + type: boolean |
| 134 | + tokenQueryKey: |
| 135 | + type: string |
| 136 | + type: object |
| 137 | + oAuthIntro: |
| 138 | + description: AccessControlOAuthIntro configures an OAuth 2.0 Token |
| 139 | + Introspection access control policy. |
| 140 | + properties: |
| 141 | + claims: |
| 142 | + type: string |
| 143 | + clientConfig: |
| 144 | + description: AccessControlOAuthIntroClientConfig configures the |
| 145 | + OAuth 2.0 client for issuing token introspection requests. |
| 146 | + properties: |
| 147 | + headers: |
| 148 | + additionalProperties: |
| 149 | + type: string |
| 150 | + description: Headers to set when sending requests to the Authorization |
| 151 | + Server. |
| 152 | + type: object |
| 153 | + maxRetries: |
| 154 | + default: 3 |
| 155 | + description: MaxRetries defines the number of retries for |
| 156 | + introspection requests. |
| 157 | + type: integer |
| 158 | + timeoutSeconds: |
| 159 | + default: 5 |
| 160 | + description: TimeoutSeconds configures the maximum amount |
| 161 | + of seconds to wait before giving up on requests. |
| 162 | + type: integer |
| 163 | + tls: |
| 164 | + description: TLS configures TLS communication with the Authorization |
| 165 | + Server. |
| 166 | + properties: |
| 167 | + ca: |
| 168 | + description: CA sets the CA bundle used to sign the Authorization |
| 169 | + Server certificate. |
| 170 | + type: string |
| 171 | + insecureSkipVerify: |
| 172 | + description: |- |
| 173 | + InsecureSkipVerify skips the Authorization Server certificate validation. |
| 174 | + For testing purposes only, do not use in production. |
| 175 | + type: boolean |
| 176 | + type: object |
| 177 | + tokenTypeHint: |
| 178 | + description: |- |
| 179 | + TokenTypeHint is a hint to pass to the Authorization Server. |
| 180 | + See https://tools.ietf.org/html/rfc7662#section-2.1 for more information. |
| 181 | + type: string |
| 182 | + url: |
| 183 | + description: URL of the Authorization Server. |
| 184 | + type: string |
| 185 | + required: |
| 186 | + - url |
| 187 | + type: object |
| 188 | + forwardHeaders: |
| 189 | + additionalProperties: |
| 190 | + type: string |
| 191 | + type: object |
| 192 | + tokenSource: |
| 193 | + description: |- |
| 194 | + TokenSource describes how to extract tokens from HTTP requests. |
| 195 | + If multiple sources are set, the order is the following: header > query > cookie. |
| 196 | + properties: |
| 197 | + cookie: |
| 198 | + description: Cookie is the name of a cookie. |
| 199 | + type: string |
| 200 | + header: |
| 201 | + description: Header is the name of a header. |
| 202 | + type: string |
| 203 | + headerAuthScheme: |
| 204 | + description: |- |
| 205 | + HeaderAuthScheme sets an optional auth scheme when Header is set to "Authorization". |
| 206 | + If set, this scheme is removed from the token, and all requests not including it are dropped. |
| 207 | + type: string |
| 208 | + query: |
| 209 | + description: Query is the name of a query parameter. |
| 210 | + type: string |
| 211 | + type: object |
| 212 | + required: |
| 213 | + - clientConfig |
| 214 | + - tokenSource |
| 215 | + type: object |
| 216 | + oidc: |
| 217 | + description: AccessControlPolicyOIDC holds the OIDC authentication |
| 218 | + configuration. |
| 219 | + properties: |
| 220 | + authParams: |
| 221 | + additionalProperties: |
| 222 | + type: string |
| 223 | + type: object |
| 224 | + claims: |
| 225 | + type: string |
| 226 | + clientId: |
| 227 | + type: string |
| 228 | + disableAuthRedirectionPaths: |
| 229 | + items: |
| 230 | + type: string |
| 231 | + type: array |
| 232 | + forwardHeaders: |
| 233 | + additionalProperties: |
| 234 | + type: string |
| 235 | + type: object |
| 236 | + issuer: |
| 237 | + type: string |
| 238 | + logoutUrl: |
| 239 | + type: string |
| 240 | + redirectUrl: |
| 241 | + type: string |
| 242 | + scopes: |
| 243 | + items: |
| 244 | + type: string |
| 245 | + type: array |
| 246 | + secret: |
| 247 | + description: |- |
| 248 | + SecretReference represents a Secret Reference. It has enough information to retrieve secret |
| 249 | + in any namespace |
| 250 | + properties: |
| 251 | + name: |
| 252 | + description: name is unique within a namespace to reference |
| 253 | + a secret resource. |
| 254 | + type: string |
| 255 | + namespace: |
| 256 | + description: namespace defines the space within which the |
| 257 | + secret name must be unique. |
| 258 | + type: string |
| 259 | + type: object |
| 260 | + x-kubernetes-map-type: atomic |
| 261 | + session: |
| 262 | + description: Session holds session configuration. |
| 263 | + properties: |
| 264 | + domain: |
| 265 | + type: string |
| 266 | + path: |
| 267 | + type: string |
| 268 | + refresh: |
| 269 | + type: boolean |
| 270 | + sameSite: |
| 271 | + type: string |
| 272 | + secure: |
| 273 | + type: boolean |
| 274 | + type: object |
| 275 | + stateCookie: |
| 276 | + description: StateCookie holds state cookie configuration. |
| 277 | + properties: |
| 278 | + domain: |
| 279 | + type: string |
| 280 | + path: |
| 281 | + type: string |
| 282 | + sameSite: |
| 283 | + type: string |
| 284 | + secure: |
| 285 | + type: boolean |
| 286 | + type: object |
| 287 | + type: object |
| 288 | + oidcGoogle: |
| 289 | + description: AccessControlPolicyOIDCGoogle holds the Google OIDC authentication |
| 290 | + configuration. |
| 291 | + properties: |
| 292 | + authParams: |
| 293 | + additionalProperties: |
| 294 | + type: string |
| 295 | + type: object |
| 296 | + clientId: |
| 297 | + type: string |
| 298 | + emails: |
| 299 | + description: Emails are the allowed emails to connect. |
| 300 | + items: |
| 301 | + type: string |
| 302 | + minItems: 1 |
| 303 | + type: array |
| 304 | + forwardHeaders: |
| 305 | + additionalProperties: |
| 306 | + type: string |
| 307 | + type: object |
| 308 | + logoutUrl: |
| 309 | + type: string |
| 310 | + redirectUrl: |
| 311 | + type: string |
| 312 | + secret: |
| 313 | + description: |- |
| 314 | + SecretReference represents a Secret Reference. It has enough information to retrieve secret |
| 315 | + in any namespace |
| 316 | + properties: |
| 317 | + name: |
| 318 | + description: name is unique within a namespace to reference |
| 319 | + a secret resource. |
| 320 | + type: string |
| 321 | + namespace: |
| 322 | + description: namespace defines the space within which the |
| 323 | + secret name must be unique. |
| 324 | + type: string |
| 325 | + type: object |
| 326 | + x-kubernetes-map-type: atomic |
| 327 | + session: |
| 328 | + description: Session holds session configuration. |
| 329 | + properties: |
| 330 | + domain: |
| 331 | + type: string |
| 332 | + path: |
| 333 | + type: string |
| 334 | + refresh: |
| 335 | + type: boolean |
| 336 | + sameSite: |
| 337 | + type: string |
| 338 | + secure: |
| 339 | + type: boolean |
| 340 | + type: object |
| 341 | + stateCookie: |
| 342 | + description: StateCookie holds state cookie configuration. |
| 343 | + properties: |
| 344 | + domain: |
| 345 | + type: string |
| 346 | + path: |
| 347 | + type: string |
| 348 | + sameSite: |
| 349 | + type: string |
| 350 | + secure: |
| 351 | + type: boolean |
| 352 | + type: object |
| 353 | + type: object |
| 354 | + type: object |
| 355 | + status: |
| 356 | + description: The current status of this access control policy. |
| 357 | + properties: |
| 358 | + specHash: |
| 359 | + type: string |
| 360 | + syncedAt: |
| 361 | + format: date-time |
| 362 | + type: string |
| 363 | + version: |
| 364 | + type: string |
| 365 | + type: object |
| 366 | + type: object |
| 367 | + served: true |
| 368 | + storage: true |
0 commit comments