[API 게 이 트 웨 이 kong 시리즈 8] - key - auth 플러그 인

1. 머리말
Kong 의 핵심 원칙 중 하 나 는 플러그 인 을 통 해 확장 할 수 있다 는 것 이다.플러그 인 은 서비스 에 새로운 기능 을 쉽게 추가 하거나 관리 하기 쉽게 할 수 있 습 니 다.
2. key - auth 플러그 인
다음 단계 에서 키 - auth 플러그 인 을 설정 하여 서비스 에 인증 을 추가 합 니 다.이 플러그 인 을 추가 하기 전에 서비스 에 대한 모든 요청 은 상위 에이전트 에 있 습 니 다.이 플러그 인 을 추가 하고 설정 한 후, 올 바른 키 를 가 진 요청 만 프 록 시 됩 니 다. - 모든 다른 요청 은 Kong 에 의 해 거부 되 어 상위 서비스 가 권한 없 이 사용 되 지 않도록 보호 합 니 다.
3. Key - auth 플러그 인 설정
Kong 에서 설정 한 서비스 에 key - auth 플러그 인 을 설정 하려 면 다음 cURL 요청 을 보 내 십시오.
3.1 서비스 에서 플러그 인 시작

$ curl -i -X POST \
  --url http://localhost:8001/services/{service name }/plugins/ \
  --data 'name=key-auth'

3.2, Route 에서 플러그 인 시작

$ curl -i -X POST \
  --url http://localhost:8001/routes/{routes id or name }/plugins/ \
  --data 'name=key-auth'

메모: 이 플러그 인 은 config. key 도 받 습 니 다.name 의 기본 인자 [apikey].그 는 제목 과 매개 변수 이름 목록 (둘 다 지원) 입 니 다. 요청 기간 에 apikey 인 자 를 포함 해 야 합 니 다.
3.3, key - auth Api 매개 변수 목록
형식 매개 변수
기본 값
묘사 하 다.
name
플러그 인 이름
serivce_id
서비스 id
toute_id
경로 id
enabled
TRUE
사용 할 지 여부
config.key_names
apikey
key 의 이름, 쉼표 로 구분 하여 대소 문자, 숫자, 밑줄 등 만 가능 합 니 다.
config.key_in_body
FALSE
사용 하면 플러그 인 이 요청 체 를 읽 고 키 를 읽 으 려 고 시도 합 니 다.
config.hide_credentials
인증 에 실패 하면 이 값 (소비의 uid) 은 익명 사용자 로 사 용 됩 니 다.비어 있 으 면 인증 실패 알림 요청 실패 4xx, 이 값 은 custom 이 아 닌 소비자 id 속성 을 만들어 야 합 니 다.id
config.ren_on_preflight
TRUE
true 로 설정 하면 플러그 인 은 요청 하기 전에 실 행 됩 니 다.false 라면 요청 은 항상 허 용 됩 니 다.
상기 조작 에 따라 간단 한 플러그 인 이 자주 완 성 됩 니 다. 저 는 테스트 할 때 service 에 만 들 었 습 니 다. 에서 의 서비스 예 시 를 사 용 했 습 니 다.
3.4 인증 플러그 인
key - auth 플러그 인 이 설정 되 어 있 는 지 확인 하기 위해 다음 CURL 명령 을 보 냅 니 다.

$ curl -i -X GET \
  --url http://localhost:8000/ \
  --header 'Host: example.com'

모든 apikey heaser 나 인자 가 지정 되 지 않 았 기 때문에 응답 은 401 Unauthorized 입 니 다.

HTTP/1.1 401 Unauthorized
...

{
  "message": "No API key found in request"
}

위 에서 저 희 는 키 - auth 플러그 인 을 성공 적 으로 설정 하 였 습 니 다. 저희 가 서비스 에 소비 자 를 추가 하여 홍콩 을 통 해 대리 요청 을 계속 할 수 있 도록 하려 고 합 니 다.
4. 소비자 추가
소비자 소비자 소비자 저 는 여기 서 많은 소 개 를 했 을 뿐 입 니 다. 아직 모 르 는 것 은 을 보면 Jason 이라는 소비 자 를 만 들 수 있 습 니 다.

$ curl -i -X POST \
  --url http://localhost:8001/consumers/ \
  --data "username=Jason"

응답 은 다음 과 같 습 니 다.

HTTP/1.1 201 Created
Content-Type: application/json
Connection: keep-alive

{
  "username": "Jason",
  "created_at": 1428555626000,
  "id": "bbdf1c48-19dc-4ab7-cae0-ff4f59d87dc9"
}

이 성공 적 으로 소비 자 를 Kong 에 추가 합 니 다. 주의: customid 를 만 들 때 소 비 를 만 들 수 있 습 니 다. 이 인 자 를 지정 합 니 다.
5. 소비자 에 게 키 증명 서 를 제공한다.

$ curl -i -X POST \
  --url http://localhost:8001/consumers/Jason/key-auth/ \
  --data 'key=ENTER_KEY_HERE'

6. 검증
다음 요청 을 보 내 서 Jason 키 가 유효한 지 확인 할 수 있 습 니 다.

  $ curl -i -X GET \
  --url http://localhost:8000 \
  --header "Host: example.com" \
  --header "apikey: ENTER_KEY_HERE"

자, 여기까지 키 - auth 플러그 인 이 설정 되 었 습 니 다.
7. 총화
플러그 인의 사용 도 간단 합 니 다. 주로 다음 과 같은 몇 가지 절차 입 니 다.1: 우선 service 나 route 에서 플러그 인 을 사용 해 야 합 니 다.2: 플러그 인 에 소비 자 를 만 들 고 방문 증명 서 를 설정 해 야 합 니 다.
Kong 게 이 트 웨 이에 대해 더 알 고 싶 은 것 은 이동 하 십시오 > > > > 기업 급 API 게 이 트 웨 이 Kong