OIDC 싱글 사인온 커스텀 도메인 교체 절차 (배포 플랜 URL 주소 교체 방안, 더 이상 권장하지 않음)¶

이 방안은 새로운 연동 시나리오에는 더 이상 권장되지 않습니다.

현재는 [커스텀 OIDC 연동 (배포 플랜)](./oidc-custom-access.md)을 사용하여 Func에서 로그인 주소, `redirect_uri`, 콜백 주소 및 사용자 정보 포맷팅 로직을 통합하는 방식을 권장합니다. 이 방식은 단일 IDP, 다중 IDP 및 다양한 비표준 OIDC 호환 시나리오에 더 적합합니다.

# OIDC 클라이언트 구성 (해당 구성에 wellKnowURL이 설정된 경우 KeyCloakPassSet 구성 항목이 자동으로 비활성화됨)
OIDCClientSet:
  # OIDC Endpoints 구성 주소, 즉 전체 `https://xxx.xxx.com/xx/.well-known/openid-configuration` 주소입니다.
  wellKnowURL: https://xxx.xxx.com/xx/.well-known/openid-configuration
  # 인증 서비스에서 제공하는 클라이언트 ID
  clientId: xxx
  # 클라이언트 시크릿 키
  clientSecret: xxxx

  # 다음은 사용자 정의 구성 부분입니다 (oidc 프로세스의 다양한 주소를 사용자 정의하는 데 사용). 바로 복사 가능합니다.
  requestSet:
    login:
      redirectUriFormatRequest:
        # 스위치 활성화
        isOpen: true
        url: "func의 함수 요청 주소 (아래 redirect_uri_format 함수 외부 링크에 해당)"

      urlFormatRequest:
        # 스위치, 기본값 비활성화
        isOpen: true
        url: "func의 함수 요청 주소 (아래 login_auth_url_format 함수 외부 링크에 해당)"

    callback:
      redirectUriFormatRequest:
        # 스위치, 기본값 비활성화
        isOpen: true
        description: "login 하위의 redirectUriFormatRequest 구성 설명과 동일"
        url: "func의 함수 요청 주소 (아래 redirect_uri_format 함수 외부 링크에 해당)"
      urlFormatRequest:
        # 스위치, 기본값 비활성화
        isOpen: true
        url: "func의 함수 요청 주소 (아래 callback_url_format 함수 외부 링크에 해당)"

아래 스크립트는 주소 포맷팅 처리 로직을 설명하기 위한 예시입니다.

스크립트에 `clientSecret`, Token 또는 기타 민감한 자격 증명을 직접 하드코딩하지 않는 것이 좋습니다. 키 정보가 필요한 경우 Func 측의 비밀번호 유형 환경 변수를 통해 주입 및 읽기하는 것을 우선적으로 사용하세요.

import json
import copy
import requests
from urllib.parse import urlparse, parse_qs, urlencode, urlunparse
from collections import OrderedDict

def parse_url(url):
    '''
    url을 파싱하여 통합된 url 파싱 객체와 쿼리 매개변수 딕셔너리 데이터를 반환합니다.

    '''
    # url 정보 파싱
    parsed_url = urlparse(url)
    # 도메인 전달은 url 매개변수에 배치
    query_params = parse_qs(parsed_url.query)
    # OrderedDict를 사용하여 매개변수의 원래 순서 유지
    ordered_params = OrderedDict(query_params)
    return parsed_url, ordered_params

def __make_redirect_uri(url, headers):
    '''
    요청 헤더에서 요청 출처 주소를 추출합니다. 이 주소는 X-Forwarded-Host 헤더에서 추출합니다.

    '''
    # redirect_uri 파싱
    parsed_url, ordered_params = parse_url(url)
    x_host = headers.get("X-Forwarded-Host")
    x_port = headers.get("X-Forwarded-Port")
    x_scheme = headers.get("X-Forwarded-Scheme", "").lower()
    if not x_scheme:
        x_scheme = copy.deepcopy(parsed_url.scheme)

    netloc = copy.deepcopy(parsed_url.netloc)
    if x_host:
        if (x_scheme == "http" and x_port == "80") or (x_scheme == "https" and x_port == "443"):
            netloc = x_host
        else:
            netloc = f"{x_host}:{x_port}" if x_port else x_host

    parsed_url = parsed_url._replace(scheme=x_scheme, netloc=netloc)
    new_url = urlunparse(parsed_url)
    return new_url


@DFF.API('redirectUriFormatRequest 함수에 해당 - oidc client의 redirect_uri 정보 포맷팅')
def redirect_uri_format(**kwargs):
    '''
    Guance OIDC 프로세스 연동 시, 비표준 프로세스로 인해 redirect_uri 매개변수명 또는 매개변수 값이 변경되는 경우, 현재 함수를 통해 처리해야 합니다.

    Parameters:
      type {str} 현재 작업이 oidc 프로세스에서 해당하는 유형, login은 oidc/login 요청의 주소 변경, callback은 oidc/callback 프로세스 요청
      redirect_uri {str} 원래 redirect_uri 주소
      args {json} 프로세스에 해당하는 요청의 쿼리 매개변수
      headers {json} 프로세스에 해당하는 요청 헤더 정보

    return {"redirect_uri": "변경된 redirect_uri 주소"}
    '''
    print("kwargs--->>>", json.dumps(kwargs))
    # 원래 redirect_uri 주소와 요청 헤더 정보 추출
    redirect_uri = kwargs.get("redirect_uri", "")
    headers = kwargs.get("headers", {})
    # 새로운 redirect_uri 주소 생성
    new_url = __make_redirect_uri(redirect_uri, headers)

    result = {
        # 이 주소는 원래의 로그인 인증 코드 획득 주소를 제공
        "redirect_uri": new_url,
    }
    print("result-->>", result)
    return result


@DFF.API('urlFormatRequest 함수에 해당 - login의 리디렉션 주소 정보 포맷팅')
def login_auth_url_format(**kwargs):
    '''
    Guance OIDC 프로세스 연동 시, 비표준 프로세스로 인해 login 주소의 매개변수를 변경해야 하는 경우, 현재 함수에서 처리할 수 있습니다.

    Parameters:
      type {str} 현재 작업이 oidc 프로세스에서 해당하는 유형, login은 oidc/login 요청의 주소 변경, callback은 oidc/callback 프로세스 요청
      url {str} 원래 url 주소
      args {json} 프로세스에 해당하는 요청의 쿼리 매개변수
      headers {json} 프로세스에 해당하는 요청 헤더 정보

    return {"url": "변경된 url 주소"}
    '''
    print("kwargs--->>>", json.dumps(kwargs))
    url = kwargs.get("url")
    new_url = None
    args = kwargs.get("args")
    headers = kwargs.get("headers")
    new_host = headers.get("X-From")
    if new_host:
        # url 정보 파싱
        parsed_url = urlparse(url)
        parsed_url = parsed_url._replace(netloc=new_host)
        new_url = urlunparse(parsed_url)

    result = {
        # 이 주소는 원래의 로그인 인증 코드 획득 주소를 제공
        "url": new_url or url
    }
    print("result-->>", result)
    return result


@DFF.API('urlFormatRequest 함수에 해당 - callback의 리디렉션 주소 정보 포맷팅')
def callback_url_format(**kwargs):
    '''
    Guance OIDC 프로세스 연동 시, 비표준 프로세스로 인해 callback 후 Guance 워크스페이스 로그인 주소의 매개변수를 변경해야 하는 경우, 현재 함수에서 처리할 수 있습니다.

    Parameters:
      type {str} 현재 작업이 oidc 프로세스에서 해당하는 유형, login은 oidc/login 요청의 주소 변경, callback은 oidc/callback 프로세스 요청
      url {str} 원래 url 주소
      args {json} 프로세스에 해당하는 요청의 쿼리 매개변수
      headers {json} 프로세스에 해당하는 요청 헤더 정보

    return {"url": "변경된 url 주소"}
    '''
    print("kwargs--->>>", json.dumps(kwargs))
    type = kwargs.get("type")
    url = kwargs.get("url")
    args = kwargs.get("args") or {}
    headers = kwargs.get("headers") or {}
    new_url = None
    from_v = args.get("from")
    if from_v:
        # url 파싱
        parsed_url, ordered_params = parse_url(url)
        ordered_params["from"] = from_v
        # 쿼리 문자열 재구성, 원래 순서 유지
        new_query_string = urlencode(ordered_params, doseq=True)
        parsed_url = parsed_url._replace(query=new_query_string)
        new_url = urlunparse(parsed_url)

    result = {
        # 이 주소는 callback 성공 후 프런트엔드로 로그인하는 주소 조정을 제공
        "url": new_url or url,
    }
    return result