Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas App Services
/
사용자 인증 및 관리
/
인증 공급자

사용자 지정 기능 인증

이 페이지의 내용

  • 개요
  • 사용자 지정 함수 인증을 사용해야 하는 경우
  • 인증 함수
  • 사용자 지정 자격 증명 페이로드 받기
  • 인증된 사용자 ID 반환
  • 인증 실패 시 오류 발생
  • 사용자 지정 함수 제공자 설정
  • 사용자 지정 사용자 데이터 구성
  • Realm SDK에서 로그인

개요

사용자 지정 함수 인증 제공자를 사용하면 서버리스 함수를 사용하여 사용자 지정 인증 흐름을 정의할 수 있습니다. 이 제공자를 사용하여 자체 사용자 인증 논리를 구현하거나 외부 인증 시스템을 통합할 수 있습니다.

사용자 지정 함수 인증을 사용해야 하는 경우

사용자 지정 함수 인증은 가장 유연한 인증 형태입니다. 그러나 인증 흐름을 직접 수동으로 정의하고 구성해야 합니다.

사용자 지정 함수 제공자를 정의하기 전에 기본 제공 인증 제공자를 대신 사용할 수 있는지 고려하세요.

다음과 같은 경우 앱에서 사용자 지정 함수 제공자를 사용하는 것이 좋습니다:

  • 내장된 제공자가 없는 외부 인증 서비스를 사용하려고 합니다. 서비스에서 JSON web token을 사용하는 경우 대신 사용자 지정 JWT 제공자를 만드는 것을 고려하세요.

  • 내장된 제공자에서 사용할 수 있는 기능 이상으로 인증 프로세스를 맞춤 설정하려고 합니다. 예를 들어 서비스를 사용하여 기본 이메일/비밀번호 제공자 이메일 대신 사용자 정의된 확인 이메일을 보낼 수 있습니다.

중요

Atlas App Services는 사용자 지정 함수 제공자에 대해 데이터 검증 또는 인증 검사를 수행하지 않습니다.

들어오는 데이터의 유효성을 검사하고 인증 시스템이 비밀번호, 2단계 인증 등의 적절한 인증 검사를 수행하는지 확인합니다. , 또는 싱글 사인온 토큰.

다음 다이어그램은 사용자 지정 함수 로그온 프로세스를 보여줍니다:

사용자 지정 함수 인증 흐름도

인증 함수

인증 함수는 사용자가 정의한 사용자 인증 코드를 보유하는 JavaScript 함수입니다. 사용자가 사용자 정의 함수 제공자를 통해 로그인할 때마다 실행됩니다.

이 함수는 사용자 이름과 비밀번호 또는 액세스 토큰과 같이 로그인 시 제공된 데이터를 외부 인증 시스템에서 사용자를 고유하게 식별하는 문자열에 매핑합니다. 예를 들어 제공된 데이터를 사용하여 HTTP를 통해 또는 npm의 패키지를 사용하여 외부 서비스에 로그인할 수 있습니다.

exports = async function (payload) {
  // 1. Parse the `payload` object, which holds data from the
  //    FunctionCredential sent by the SDK.
  const { username, password } = payload;
  // 2. Create a new user or log in an existing user in the external
  //    authentication service.
  // You can use a client library from npm
  const auth = require("fake-auth-service");
  const user = await auth.login({ username, password });
  // Or you can communicate directly over HTTP
  const userFromHttp = await context.http.post({
    url: "https://example.com/auth/login",
    headers: {
      Authorization: ["Basic bmlja0BleGFtcGxlLmNvbTpQYTU1dzByZA=="],
    },
    body: JSON.stringify({ username, password }),
  });
  // 3. Return a unique identifier for the user. Typically this is the
  //    user's ID in the external authentication system or the _id of a
  //    stored MongoDB document that describes them.
  //
  //    !!! This is NOT the user's internal account ID for your app !!!
  return user.id;
};

사용자 지정 자격 증명 페이로드 받기

함수에 전달된 payload 객체에는 클라이언트 앱의 사용자 지정 함수 제공자 자격 증명과 함께 포함된 데이터가 들어 있습니다. 이 함수는 클라이언트 앱에서 제공하는 모든 값을 받아들이므로 실제 필드 이름과 값은 구현에 따라 달라집니다.

Realm SDK를 사용하여 사용자 정의 자격 증명 payload 객체를 생성하는 방법에 대한 예는 각 SDK에 대한 문서를 참조하세요.

인증된 사용자 ID 반환

인증이 성공하면 함수는 사용자에 대한 고유한 문자열 식별자를 반환해야 합니다. 예를 들어 외부 인증 시스템에서 사용하는 사용자 ID 값을 반환할 수 있습니다. 이 ID는 제공자가 사용자 지정 시스템에서 앱의 내부 사용자 계정으로 매핑하는 데 사용하는 사용자의 외부 ID입니다.

중요

사용자의 외부 ID는 사용자 객체의 id 필드로 노출되는 사용자의 내부 계정 ID와 동일하지 않습니다. 표현식에서는 %%user.id, 함수에서는 context.user.id, SDK에서는 User.id 속성을 사용하여 사용자의 내부 ID에 액세스합니다.

기존 사용자가 이미 외부 ID와 연결되어 있는 경우 제공자는 해당 사용자를 로그인합니다.

제공자에 지정된 외부 ID에 대한 기록이 없는 경우 제공자는 새 사용자 계정을 만들고 사용자 지정 함수 제공자 ID를 추가한 다음 새 사용자를 로그인합니다.

사용자 지정 함수 제공자에 대한 ID 객체는 사용자 객체에 저장되며 다음과 유사합니다:

{
  "id": "<Internal User Account ID>",
  "identities": [
     {
       "providerType": "custom-function",
       "id": "<External User ID>",
     }
  ]
}

예시

인증 함수는 고유한 외부 ID를 문자열로 반환해야 합니다:

return "5f650356a8631da45dd4784c"

외부 ID를 id 값으로 포함하는 객체를 반환할 수도 있습니다.

return { "id": "5f650356a8631da45dd4784c" }

사용자의 표시 이름을 정의하려면 반환된 객체의 name 필드에 정의하세요.

return {
  "id": "5f650356a8631da45dd4784c",
  "name": "James Bond"
}

인증 실패 시 오류 발생

사용자가 잘못된 자격 증명을 제공했거나 함수가 사용자를 인증하지 못한 경우 설명 메시지와 함께 오류가 발생합니다. 이 경우 SDK에 첨부된 메시지와 함께 401 - Unauthorized 오류를 반환합니다.

const auth = require("some-external-auth-system");
try {
  const user = await auth.login(payload);
  return user.id;
} catch (err) {
  throw new Error(`Authentication failed with reason: ${err.message}`);
}

사용자 지정 함수 제공자 설정

지원되는 배포 메서드를 사용하여 사용자 지정 함수 인증을 구성할 수 있습니다.

1

사용자 지정 함수 제공자 활성화

제공자를 활성화합니다:

  1. 왼쪽 탐색 메뉴에서 App Users를 클릭합니다.

  2. 0}Providers 탭을 선택합니다.

  3. Custom Function Authentication를 클릭합니다.

  4. 제공자 구성 화면에서 Provider Enabled 토글을 On로 설정합니다.

사용자 지정 함수 제공자 가 강조 표시된 App Services UI 의 인증 제공자 목록입니다.
클릭하여 확대
2

인증 함수 정의

제공자는 일반 함수를 사용하여 인증을 처리합니다. 이 함수는 사용자를 식별하기 위해 고유한 외부 ID 문자열을 반환해야 합니다.

새 인증 함수를 정의하려면 다음을 따르세요.

  1. Function 드롭다운을 클릭하여 New Function를 선택합니다.

  2. 함수의 이름을 입력합니다. 이 이름은 애플리케이션의 모든 기능 중에서 고유해야 합니다.

  3. 함수 편집기에서 소스 코드를 정의합니다.

  4. 클릭 Save

App Services UI 의 함수 선택 드롭다운입니다.
클릭하여 확대
3

업데이트된 애플리케이션 배포

사용자 지정 함수 인증을 클라이언트 애플리케이션에서 사용할 수 있도록 하려면 애플리케이션을 배포합니다.

  1. 왼쪽 탐색에서 Deploy 을 클릭합니다.

  2. 배포서버 기록 테이블에서 초안을 찾은 다음 Review & Deploy Changes을 클릭합니다.

  3. 변경 사항의 차이를 검토한 다음 Deploy을(를) 클릭합니다.

1

앱의 최신 버전 가져오기

최신 버전의 앱의 로컬 사본을 가져오려면 다음을 실행하세요.

appservices pull --remote="<Your App ID>"

팁

Realm UI의 Deploy > Export App 화면에서 애플리케이션의 구성 파일 사본을 다운로드할 수도 있습니다.

2

인증 함수 정의

제공자는 일반 함수를 사용하여 인증을 처리합니다. 이 함수는 사용자를 식별하기 위해 고유한 외부 ID 문자열을 반환해야 합니다. 사용자.

인증 함수 코드를 functions 디렉토리 에 저장합니다.

touch functions/handleCustomFunctionAuthentication.js
3

제공자 구성 파일 추가

사용자 지정 함수 인증 제공자를 활성화하고 구성하려면 /auth/providers.json 에서 구성 객체 를 정의합니다.

사용자 지정 함수 제공자 구성의 형식은 다음과 같습니다.

/auth/providers.json
{
  "custom-function": {
    "name": "custom-function",
    "type": "custom-function",
    "config": {
      "authFunctionName": "<Authentication Function Name>"
    },
    "disabled": false
  }
}
4

업데이트된 애플리케이션 배포

인증 함수를 생성하고 제공자를 구성한 후에는 업데이트된 구성을 원격 앱에 푸시할 수 있습니다. App Services CLI는 푸시 시 새 스키마를 즉시 배포합니다.

appservices push --remote="<Your App ID>"

사용자 지정 사용자 데이터 구성

MongoDB Atlas 컬렉션의 사용자 지정 데이터를 앱의 사용자 계정과 연결할 수 있습니다. 이는 사용자 데이터에 자주 액세스해야 하지만 사용자 지정 함수 제공자를 사용할 필요가 없는 경우에 유용할 수 있습니다.

사용자의 사용자 지정 데이터 문서에는 모든 데이터가 포함될 수 있습니다. 사용자 지정 함수 제공자를 사용하는 앱의 경우 사용자의 내부 사용자 계정 ID와 외부 ID를 모두 저장하는 것이 좋습니다.

예를 들어 다음 형식을 사용할 수 있습니다:

{
  "_id": "<Generated ObjectId>",
  "user_id": "<Internal User ID>",
  "external_id": "<External User ID>"
}

다음 접근 방식을 사용하여 사용자 지정 함수 제공자 사용자를 위한 사용자 정의 사용자 문서를 생성할 수 있습니다.

  1. 연결된 클러스터의 컬렉션에 대한 사용자 지정 사용자 데이터를 구성합니다. 사용자 ID 필드에는 사용자의 내부 계정 ID가 저장됩니다.

    /auth/custom_user_data.json
    {
      "mongo_service_name": "mongodb-atlas",
      "database_name": "myApp",
      "collection_name": "users",
      "user_id_field": "user_id",
      "enabled": true
    }

  2. 사용자 지정 함수 인증 제공자를 구성하고 인증 함수에서 고유한 외부 사용자 ID를 반환합니다. App Services는 이 ID를 사용자 custom-function ID의 id 필드에 저장합니다.

    exports = async function handleCustomFunctionAuth(payload) {
      const auth = require("some-external-auth-system");
      const user = await auth.login(payload);
      return user.id;
    };

  3. custom-function 제공자로부터 CREATE 이벤트를 수신하는 인증 트리거를 설정합니다. 트리거 함수에서 사용자의 내부 ID와 외부 ID를 모두 포함하는 사용자 지정 사용자 데이터 컬렉션에 새 문서를 추가합니다.

    exports = async function onNewCustomFunctionUser({ user }) {
      // This is the user's internal account ID that was generated by your app
      const internalId = user.id;
      // This is the external ID returned from the authentication function
      const customFunctionIdentity = user.identities.find((id) => {
        return id.provider_type === "custom-function";
      });
      const externalId = customFunctionIdentity.id;
      // Create a custom user data document for the user
      const mdb = context.services.get("mongodb-atlas");
      const users = mdb.db("myApp").collection("users");
      return await users.insertOne({
        // Include both the internal ID and external ID
        user_id: internalId,
        external_id: externalId,
        // Add any other data you want to include
        created_at: new Date(),
      });
    };

Realm SDK에서 로그인

클라이언트 애플리케이션에서 로그인하려면 로그인 페이로드 데이터가 포함된 사용자 지정 함수 자격 증명을 사용합니다.

예를 들어 특정 SDK에 대한 설명서를 참조하세요.

돌아가기

애플 아이디

다음

사용자 지정 JWT