oidc client

@axa-fr/oidc-client

• О
• Начиная
• Запустить демо
• Как это работает
• Пакеты
  • @axa-fr/oidc-client
  • @axa-fr/react-oidc
  • @axa-fr/svelte-oidc : мы ищем участника
  • @axa-fr/vue-oidc : мы ищем участника
  • @axa-fr/angular-oidc : мы ищем участника
• Часто задаваемые вопросы
• Миграции
• Способствовать

О

@axa-fr/oidc-client самая легкая и безопасная библиотека для управления аутентификацией с помощью протокола OpenID Connect (OIDC) и OAuth2. Он совместим со всеми поставщиками OIDC. @axa-fr/oidc-client -это чистая библиотека JavaScript. Он работает с любым фреймворком JavaScript или библиотекой. @ AXA-FR/ React - oid

Демо:

• Попробуйте демонстрацию React по адресу https://black-rock-0dc6b0d03.1.azurestaticApps.net/ (самый продвинутый)
• Попробуйте демонстрацию Pure JavaScript по адресу https://icy-glacier-004ab4303.2.azurestaticapss.net/

@axa-fr/oidc-client -это:

• Безопасный :
  • С демонстрацией доказательства владения (DPOP), ваш Access_token и refresh_token не используются вне контекста вашего браузера (большая защита)
  • С использованием работника службы ваши токены (rewresh_token и/или access_token) недоступны для клиентского кода JavaScript (если вы следите за хорошими практиками из раздела FAQ )
  • OIDC с использованием гранта кода клиента кода только с PKCE
• Легкий вес : распакованный размер на NPM составляет 274 кб , минимизированный 61.1kB , минимизированный+gzipped 16.8kB статистику Pkg через Bundlephobia.com
• Простой
  • represh_token и access_token
  • С использованием работника службы вам не нужно вводить access_token в каждом выборе, вы должны только настроить файл oidctrusteddomains.js
• Несколько аутентификаций :
  • Вы можете многократно аутентифицировать один и тот же поставщик с различными возможностями (например, вы можете приобрести новый «платеж» для оплаты)
  • Вы можете аутентифицировать несколько разных поставщиков на одном и том же сайте SPA (одностраничная приложение)
• Гибкий :
  • Работайте с сервисным работником (более безопасным) и без старшего браузера (менее безопасно).
  • Вы можете отключить обслуживающий работник, если хотите (но менее безопасно) и просто использовать SessionStorage или режим LocalStorage.

Отлично работает с:

• Auth0
• Duende Identity Server
• Identity Server 4
• Azure Ad
• Google
• AWS
• KeyCloak
• и т.д., все поставщики OIDC

Начиная

Начало работы с @axa-fr/oidc-client

npm install @axa-fr/oidc-client --save

# To install or update OidcServiceWorker.js file, you can run
node ./node_modules/@axa-fr/oidc-client/bin/copy-service-worker-files.mjs public

# If you have a "public" folder, the 2 files will be created :
# ./public/OidcServiceWorker.js <-- will be updated at each "npm install"
# ./public/OidcTrustedDomains.js <-- won't be updated if already exist 

Предупреждение

Если вы используете режим Service Worker , файл OidcServiceWorker.js всегда должен быть в курсе версии библиотеки. Вы можете настроить сценарий PostInstall в вашем файле package.json , чтобы обновить его при каждой установке NPM. Например :

  "scripts" : {
    ...
    "postinstall" : " node ./node_modules/@axa-fr/oidc-client/bin/copy-service-worker-files.mjs public "
  },

Больше документации:

• @axa-fr/oidc-client

Начало работы с @axa-fr/React-oidc

npm install @axa-fr/react-oidc --save

# To install or update OidcServiceWorker.js file, you can run
node ./node_modules/@axa-fr/react-oidc/bin/copy-service-worker-files.mjs public

# If you have a "public" folder, the 2 files will be created :
# ./public/OidcServiceWorker.js <-- will be updated at each "npm install"
# ./public/OidcTrustedDomains.js <-- won't be updated if already exist 

Предупреждение

Если вы используете режим обслуживания работника, файл OIDCServiceWorker.js всегда должен быть в курсе версии библиотеки. Вы можете настроить сценарий PostInstall в вашем файле Package.json, чтобы обновить его при каждой установке NPM. Например :

  "scripts" : {
    ...
    "postinstall" : " node ./node_modules/@axa-fr/react-oidc/bin/copy-service-worker-files.mjs public "
  },

Больше документации:

• @axa-fr/react-oidc

Запустить демо

git clone https://github.com/AxaFrance/oidc-client.git

cd oidc-client
pnpm install

# oidc client demo
cd examples/oidc-client-demo
pnpm install
pnpm start
# then navigate to http://localhost:5174

# react vite demo
cd examples/react-oidc-demo
pnpm install
pnpm start
# then navigate to http://localhost:4200

# react NextJS demo
cd examples/nextjs-demo
pnpm install
pnpm run dev
# then navigate to http://localhost:3001 

Как это работает

Сервисный работник поймает access_token и represh_token , который никогда не будет доступен для клиента.

Эти компоненты инкапсулируют использование « @axa-fr/oidc-client », чтобы скрыть сложность рабочего процесса. Внутренне для « @axa-fr/react-oidc » API нативной истории используется для того, чтобы быть агностиком маршрутизатора.

Больше информации о OIDC:

• Французский: aipertez la sécurité et la sommorticité de wortre système d'sinal openid connect
• Английский: повысить безопасность и простоту вашей информационной системы с помощью OpenID Connect
• Английский: youtube React-oidc введение
• Французский: youtube React-oidc введение

Часто задаваемые вопросы

• Часто часто задаваемые вопросы FAQ

Миграции

• Мигрирование с V3 на V4 guide
• Мигрирование с V3 на V5 guide
• Мигрирование с V4 в V5 guide
• Мигрирование с V5 на V6 guide
• Мигрирование с V6 на V7 guide

Способствовать

• Как запустить решение и внести свой вклад
• Пожалуйста, уважайте наш кодекс поведения