Wasm Plugin Image Specification

apiVersion: 1.0.0  # The format version used by this file. Currently fixed at 1.0.0
info:
  category: auth # Plugin type. Options include: auth (authentication and authorization), security (security protection), protocol (protocol conversion), flow-control (traffic control), flow-monitor (traffic observation), custom (custom)
  name: basic-auth/v1  # Plugin name. This is the unique identifier of the plugin. It is recommended to append a version suffix like "/v1" to handle future incompatible upgrade scenarios
  title: Basic Auth # Display name, supports internationalization
  description: This plugin implements authentication and authorization functionality based on the HTTP Basic Auth standard. # Feature description, supports internationalization
  x-description-i18n: # Internationalization content for the description field above. All fields supporting internationalization can add internationalized content using the "x-{name}-i18n" method
    en-US: This plugin implements an authentication function based on HTTP Basic Auth standard.
  iconUrl: https://img.alicdn.com/imgextra/i1/O1CN01I7WjVs1K33EQjInid_!!6000000001107-2-tps-960-290.png # Optional, URL of the plugin's icon file.
  version: 1.0.0 # Version number
  contact: # Contact information
    name: Higress Team
    url: http://higress.cn/
    email: admin@higress.io
spec:
  phase: AUTHN # Execution phase. Please refer to https://istio.io/latest/docs/reference/config/proxy_extensions/wasm-plugin/#PluginPhase
  priority: 0 # Execution priority within the phase. Please refer to https://istio.io/latest/docs/reference/config/proxy_extensions/wasm-plugin/#WasmPlugin
  configSchema: # Data model for plugin runtime configuration, currently only supports definition using the Schema format in OpenAPI 3.0.0 standard
    openAPIV3Schema: # For the data format of the following content, please refer to https://openapi.apifox.cn/#schema-%E5%AF%B9%E8%B1%A1. Some display fields support internationalization.
      type: object
      properties:
        consumers:
          type: array
          x-scope: GLOBAL # Configuration item scope. Options: GLOBAL (global configuration), RULE (rule-level configuration, i.e., configuration when associated with specific routes, domains, services, etc.), ANY (no scope restriction). Optional. Default value is ANY.
          title: Consumer List
          x-title-i18n:
            en-US: Consumer List
          description: List of service consumers, used for request authentication
          x-description-i18n:
            en-US: List of service consumers which will be used in request authentication
          items:
            type: object
            properties:
              name:
                type: string
                title: Name
                x-title-i18n:
                  en-US: Name
                description: The name of the consumer
                x-description-i18n:
                  en-US: The name of the consumer
                # Data validation scenarios refer to JSON Schema Validation Spec implementation
                # https://json-schema.org/draft/2020-12/json-schema-validation.html
                # Currently supports the following fields:
                # - maximum
                # - minimum
                # - maxLength
                # - minLength
                # - pattern
                # - maxItems
                # - minItems
                # - required
                minLength: 6 # Minimum length, for data validation
                maxLength: 256 # Maximum length, for data validation
                pattern: "^$" # Regular expression, for data validation
                example:
                  - consumer1
              credential:
                type: string
                title: Credential
                x-title-i18n:
                  en-US: Credential
                description: The access credential of the consumer
                x-description-i18n:
                  en-US: The credential of the consumer
                example:
                  - admin:123456
            required:
              - name
              - credential
        allow:
          type: array
          title: Allowed Consumers
          x-title-i18n:
            en-US: Allowed Consumers
          description: For requests matching the above conditions, the list of consumers allowed to access
          x-description-i18n:
            en-US: Consumers to be allowed for matched requests
          items:
            type: string
            example:
              - consumer1
      required:
        - allow
        - consumers
      example:
        consumers:
          - name: consumer1
            credential: admin:123456
          - name: consumer2
            credential: guest:abc
        allow:
          - consumer2