1.20. 3scale WebAssembly 모듈 사용

서비스 메시는 ServiceMeshExtension 이라는 사이드카 프록시에 프록시-WASM 확장을 지정하고 적용하는 사용자 정의 리소스 정의를 제공합니다. 서비스 메시는 이 사용자 정의 리소스를 3scale을 사용하여 HTTP API 관리가 필요한 워크로드 집합에 적용합니다.

3scale WebAssembly 모듈 구성의 아키텍처는 3scale 계정 및 권한 부여 서비스 및 처리할 서비스 목록에 따라 다릅니다.

3scale WebAssembly 모듈의 api 최상위 문자열은 모듈에서 사용할 구성 버전을 정의합니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
  namespace: bookinfo
spec:
  config:
    api: v1
...

api 항목은 구성에 대한 나머지 값을 정의합니다. 허용되는 유일한 값은 v1 입니다. 현재 구성과의 호환성을 손상시키거나 v1 을 사용하는 모듈에서 처리할 수 없는 더 많은 논리가 필요한 새 설정에는 다른 값이 필요합니다.

시스템 최상위 오브젝트는 특정 계정의 3scale 계정 관리 API에 액세스하는 방법을 지정합니다. 업스트림 필드는 오브젝트에서 가장 중요한 부분입니다. 시스템 오브젝트는 선택 사항이지만, 3scale WebAssembly 모듈에 완전히 정적 구성을 제공하지 않는 한 권장되는데, 이는 3scale의 시스템 구성 요소에 연결을 제공하지 않으려는 경우 옵션입니다.

시스템 오브젝트 외에도 정적 구성 오브젝트를 제공하는 경우 항상 정적 오브젝트가 우선합니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  ...
  config:
    system:
      name: saas_porta
      upstream: <object>
      token: myaccount_token
      ttl: 300
  ...

업스트림 오브젝트는 프록시에서 호출을 수행할 수 있는 외부 호스트를 설명합니다.

apiVersion: maistra.io/v1
upstream:
  name: outbound|443||multitenant.3scale.net
  url: "https://myaccount-admin.3scale.net/"
  timeout: 5000
...

백엔드 최상위 오브젝트는 HTTP 요청을 인증하고 보고하기 위해 3scale Service Management API에 액세스하는 방법을 지정합니다. 이 서비스는 3scale의 백엔드 구성 요소에서 제공합니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  config:
    ...
    backend:
      name: backend
      upstream: <object>
    ...

services 최상위 오브젝트는 이 모듈 의 특정 인스턴스에서 처리할 서비스 식별자를 지정합니다.

계정에는 여러 서비스가 있으므로 처리되는 서비스를 지정해야 합니다. 나머지 구성은 서비스 구성 방법에 대해 다시 활성화됩니다.

services 필드는 필수입니다. 유용한 서비스가 하나 이상 포함되어야 하는 배열입니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  config:
    ...
    services:
    - id: "2555417834789"
      token: service_token
      authorities:
        - "*.app"
        - 0.0.0.0
        - "0.0.0.0:8443"
      credentials: <object>
      mapping_rules: <object>
    ...

services 배열의 각 요소는 3scale 서비스를 나타냅니다.

credentials 오브젝트는 서비스 오브젝트 의 구성 요소입니다. credentials 는 검색할 자격 증명 유형과 이 작업을 수행하는 단계를 지정합니다.

모든 필드는 선택 사항이지만 하나 이상의 user_key 또는 app_ id 를 지정해야 합니다. 각 자격 증명을 지정하는 순서는 모듈에 의해 사전 설정되므로 관련이 없습니다. 각 자격 증명의 인스턴스 하나만 지정합니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  config:
    ...
    services:
    - credentials:
        user_key: <array_of_lookup_queries>
        app_id: <array_of_lookup_queries>
        app_key: <array_of_lookup_queries>
    ...

lookup 쿼리 오브젝트는 자격 증명 오브젝트의 모든 필드의 일부입니다. 지정된 자격 증명 필드를 찾아서 처리하는 방법을 지정합니다. 평가 시 문제 해결은 하나 이상의 값을 찾을 수 있음을 의미합니다. 해결에 실패한 것은 값을 찾을 수 없음을 의미합니다.

조회 쿼리 배열은 단락 또는 관계를 설명합니다. 쿼리 중 하나의 성공적인 해결은 나머지 쿼리의 평가를 중지하고 값 또는 값을 지정된 자격 증명 유형에 할당합니다. 배열의 각 쿼리는 서로 독립적입니다.

조회 쿼리 는 여러 소스 유형 중 하나일 수 있는 소스 오브젝트인 단일 필드로 구성됩니다. 다음 예제를 참조하십시오.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  config:
    ...
    services:
    - credentials:
        user_key:
          - <source_type>: <object>
          - <source_type>: <object>
          ...
        app_id:
          - <source_type>: <object>
          ...
        app_key:
          - <source_type>: <object>
          ...
    ...

소스 오브젝트는 credentials 오브젝트 필드 내에 있는 소스 배열의 일부로 존재합니다. source-type이라고 하는 오브젝트 필드 이름은 다음 중 하나입니다.

모든 소스-유형 오브젝트에는 최소한 다음 두 개의 필드가 있습니다.

filter 필드 이름에는 데이터를 조회하는 데 사용하는 메타데이터의 경로를 표시하는 데 필요한 경로 항목이 있습니다.

키가 입력 데이터와 일치하면 나머지 키는 평가되지 않고 소스 확인 알고리즘이 지정된 작업(운영 )실행으로 건너뜁니다(있는 경우). ops 를 지정하지 않으면 일치하는 키 의 결과 값(있는 경우)이 반환됩니다.

작업 에서는 첫 번째 단계에서 키를 조회한 후 보유한 입력에 대한 특정 조건 및 변환을 지정하는 방법을 제공합니다. 속성을 변환, 디코딩 및 어설션할 필요가 있을 때 작업을 사용하지만 모든 요구 사항을 처리하기 위한 완성도 높은 언어를 제공하지 않고 완전한 기능을 제공하지는 않습니다.

스택은 작업 출력을 저장했습니다. 평가되면 자격 증명이 사용하는 값 수에 따라 스택 하단의 값 또는 값을 할당하여 조회 쿼리 가 끝납니다.

특정 소스 유형에 속하는 ops 배열의 각 요소는 변환을 값에 적용하거나 테스트를 수행하는 작업 오브젝트입니다. 이러한 오브젝트에 사용할 필드 이름은 작업 자체의 이름이며, 모든 값은 작업 오브젝트 의 매개 변수입니다(예: 필드 및 값, 목록 또는 문자열이 있는 맵).

대부분의 작업은 하나 이상의 입력에 참석하고 하나 이상의 출력을 생성합니다. 입력을 사용하거나 출력을 생성하는 경우 작업에서 사용하는 각 값이 값 스택에서 팝업되고 처음에 모든 소스 일치 항목이 채워집니다. 출력된 값은 스택에 푸시됩니다. 다른 작업 에서는 특정 속성을 어설션하는 것 외에 출력을 사용하거나 생성하지 않지만, 값 스택을 검사합니다.

다음과 같은 몇 가지 운영 카테고리가 있습니다.

모든 작업은 이름 식별자에서 문자열로 지정합니다.

mapping_rules 오브젝트는 서비스 오브젝트의 일부입니다. REST 경로 패턴 및 관련 3scale 지표 세트를 지정하고 패턴이 일치할 때 사용할 증가를 계산합니다.

동적 구성이 시스템 최상위 오브젝트에 제공되지 않는 경우 값이 필요합니다. 시스템 최상위 항목 외에 오브젝트가 제공되는 경우 mapping_rules 오브젝트가 먼저 평가됩니다.

mapping_rules 는 배열 오브젝트입니다. 해당 배열의 각 요소는 mapping_rule 오브젝트입니다. 수신 요청에서 평가된 일치 매핑 규칙은 APIManager 에 권한 부여 및 보고를 위한 3scale 메서드 세트를 제공합니다. 여러 일치하는 규칙이 동일한 방법을 참조하는 경우 3scale을 호출할 때 deltas 요약이 있습니다. 예를 들어, 1과 3의 deltas 를 사용하여 2개의 규칙이 Hits 메서드를 두 번 늘리면 3scale에 보고하는 Hits에 대한 단일 메서드 항목은 4입니다 .

mapping_rule 오브젝트는 mapping_rules 오브젝트에서 배열의 일부입니다.

mapping_rule 오브젝트 필드는 다음 정보를 지정합니다.

다음 예제는 3scale의 메서드 간 기존 계층 구조와 독립적입니다. 즉, 3scale 측에서 실행되는 모든 항목이 이에 영향을 주지 않습니다. 예를 들어 Hits 지표는 모두 부모일 수 있으므로 인증된 요청에 보고된 모든 메서드의 합계로 인해 4번의 적중을 저장하고 3scale Authrep API 엔드포인트를 호출합니다.

아래 예제에서는 모든 규칙과 일치하는 경로 /products/1/sold 에 GET 요청을 사용합니다.

apiVersion: maistra.io/v1
kind: ServiceMeshExtension
metadata:
  name: threescale-wasm-auth
spec:
  config:
    ...
    mapping_rules:
      - method: GET
        pattern: /
        usages:
          - name: hits
            delta: 1
      - method: GET
        pattern: /products/
        usages:
          - name: products
            delta: 1
      - method: ANY
        pattern: /products/{id}/sold
        usages:
          - name: sales
            delta: 1
          - name: products
            delta: 1
    ...

다음과 같이 사용 데이터를 사용하여 모듈이 수행하는 모든 사용량이 3scale에 추가됩니다.

다음 예제에서는 동일한 이름의 쿼리 문자열 매개 변수 또는 헤더에서 user_key 를 조회합니다.

credentials:
  user_key:
    - query_string:
        keys:
          - user_key
    - header:
        keys:
          - user_key

다음 예제에서는 쿼리 또는 헤더에서 app_key 및 app_id 자격 증명을 조회합니다.

credentials:
  app_id:
    - header:
        keys:
          - app_id
    - query_string:
        keys:
          - app_id
  app_key:
    - header:
        keys:
          - app_key
    - query_string:
        keys:
          - app_key

요청에는 권한 부여 헤더에 app_id 및 app_key 가 포함됩니다. 끝에 출력된 값이 하나 이상 있으면 app_key 를 할당할 수 있습니다.

끝에 출력된 하나 또는 두 개가 있는 경우 여기에서 해상도는 app_key 를 할당합니다.

권한 부여 헤더는 권한 유형으로 값을 지정하고 해당 값은 Base64 로 인코딩됩니다. 즉, 값을 공백 문자로 분할하고 두 번째 출력을 가져온 다음 콜론(:)을 구분자로 사용하여 다시 분할할 수 있습니다. 예를 들어 이 형식 app_id:app_key 형식을 사용하는 경우 헤더는 인증 정보에 대한 다음 예와 같습니다.

aladdin:opensesame:  Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

다음 예와 같이 소문자 헤더 필드 이름을 사용해야 합니다.

credentials:
  app_id:
    - header:
        keys:
          - authorization
        ops:
          - split:
              separator: " "
              max: 2
          - length:
              min: 2
          - drop:
              head: 1
          - base64_urlsafe
          - split:
              max: 2
  app_key:
    - header:
        keys:
          - app_key

이전 예제 사용 사례는 권한 부여 의 헤더를 확인합니다.

마지막 작업 assert 는 부작용이 스택에 발생하지 않음을 나타냅니다. 그런 다음 스택을 수정할 수 있습니다.

서비스 메시 및 3scale Istio 어댑터의 경우 다음 예에 표시된 대로 RequestAuthentication 을 배포하여 자체 워크로드 데이터 및 jwtRules 를 채워야 합니다.

apiVersion: security.istio.io/v1beta1
  kind: RequestAuthentication
  metadata:
    name: jwt-example
    namespace: bookinfo
  spec:
    selector:
      matchLabels:
        app: productpage
    jwtRules:
    - issuer: >-
        http://keycloak-keycloak.34.242.107.254.nip.io/auth/realms/3scale-keycloak
      jwksUri: >-
        http://keycloak-keycloak.34.242.107.254.nip.io/auth/realms/3scale-keycloak/protocol/openid-connect/certs

RequestAuthentication 을 적용하면 JWT 토큰을 검증하기 위해 네이티브 플러그인으로 Envoy 를 구성합니다. 프록시는 모듈을 실행하기 전에 모든 것을 검증하므로 실패한 모든 요청이 3scale WebAssembly 모듈에 연결되지 않습니다.

JWT 토큰이 검증되면 프록시는 해당 콘텐츠를 플러그인의 특정 구성에 종속된 항목으로 내부 메타데이터 오브젝트에 저장합니다. 이 사용 사례에서는 알 수 없는 키 이름이 포함된 단일 항목으로 구조 오브젝트를 검색할 수 있는 기능을 제공합니다.

OIDC의 3scale app_id 는 OAuth client_id 와 일치합니다. JWT 토큰의 azp 또는 aud 필드에 있습니다.

Envoy의 네이티브 JWT 인증 필터에서 app_id 필드를 가져오려면 다음 예제를 참조하십시오.

credentials:
  app_id:
    - filter:
        path:
          - envoy.filters.http.jwt_authn
          - "0"
        keys:
          - azp
          - aud
        ops:
          - take:
              head: 1

이 예제에서는 모듈에서 filter 소스 유형을 사용하여 Envoy-specific JWT 인증 네이티브 플러그인에서 오브젝트에 대한 필터 메타데이터를 조회하도록 지시합니다. 이 플러그인에는 단일 항목과 사전 구성된 이름이 있는 구조 오브젝트의 일부로 JWT 토큰이 포함됩니다. 0 을 사용하여 단일 항목에만 액세스하도록 지정합니다.

결과 값은 두 필드를 분석할 구조입니다.

이 작업은 할당을 위해 하나의 값만 보유합니다.

일부 설정에는 검증된 토큰이 JSON 형식의 헤더를 통해 이 모듈에 도달하는 JWT 토큰에 대한 검증 프로세스가 있을 수 있습니다.

app_id 를 가져오려면 다음 예제를 참조하십시오.

credentials:
  app_id:
    - header:
        keys:
          - x-jwt-payload
        ops:
          - base64_urlsafe
          - json:
            - keys:
              - azp
              - aud
          - take:
              head: 1