SAML - Gorbit Documentation

قم بتكوين Gorbit مع مصادقة SAML. سيرشدك هذا الدليل خلال عملية الإعداد لـ Okta. سيكون لمزودي الهوية الآخرين عملية مشابهة. يرجى التواصل معنا إذا كنت بحاجة إلى مساعدة مع مزود هوية مختلف.

تتطلب مصادقة SAML بناء صور Gorbit من المصدر!راجع التفاصيل في دليل Docker Compose.

الدليل

إنشاء تطبيق Okta

انتقل إلى Admin Console في Okta → Applications → Create App Integration.

تكوين تطبيق Okta

اختر SAML 2.0.سمِّ تطبيقك Gorbit وحمّل شعار Gorbit.

إذا كنت تستخدم علامة Gorbit التجارية الخاصة بك، يمكنك تسمية تطبيقك بحرية وتحميل شعارك الخاص.

أضف Sign sign-on URL

https://YOUR_GORBIT_DOMAIN.com/auth/saml/callback

أضف Audience URI (SP Entity ID)

https://YOUR_GORBIT_DOMAIN.com/metadata

أضف Attribute Statement حيث Name هو email و Value هو user.email.

تعيين المستخدمين للتطبيق

أنشئ التطبيق وانتقل إلى تبويب Assignments لتعيين المستخدمين.

تكوين Gorbit لـ SAML

انتقل إلى gorbit/backend/ee/gorbit/configs/saml_config وانسخ ملف الإعدادات القالب.

cd gorbit/backend/ee/gorbit/configs/saml_config
cp template_settings.yaml settings.yaml

عدّل ملف settings.yaml بالقيم التالية:

idp: entityId

اذهب إلى تبويب Sign On لتطبيقك في Okta، انسخ Metadata URL، والصقه في متصفحك. يجب أن ترى XML مثل:

<md:EntityDescriptor
    xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"
    entityID="http://www.okta.com/exkngircrvOYQyNg35d7">
...
</md:EntityDescriptor>

انسخ قيمة entityID والصقها في idp: entityId في settings.yaml.

idp: x509cert

في XML من الخطوة السابقة، ابحث عن عنصر ds:X509Certificate.

<md:KeyDescriptor use="signing">
    <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
            <ds:X509Certificate>
                [Some certificate value here]
            </ds:X509Certificate>
        </ds:X509Data>
    </ds:KeyInfo>
</md:KeyDescriptor>

انسخ قيمة الشهادة والصقها في idp: x509cert في settings.yaml.

idp: singleSignOnService: url

اذهب إلى تبويب General لتطبيقك في Okta وانسخ Embed Link.

sp: entityId

هذا هو نفس Audience URI (SP Entity ID) الذي أضفته إلى تطبيق Okta.

https://YOUR_GORBIT_DOMAIN.com/metadata

sp: assertionConsumerService: url

هذا هو نفس Sign sign-on URL الذي أضفته إلى تطبيق Okta.

https://YOUR_GORBIT_DOMAIN.com/auth/saml/callback

sp: x509cert

أنشئ شهادة موقعة ذاتيًا:

openssl genrsa -out sp-private-key.pem 2048
openssl req -new -x509 -key sp-private-key.pem -out sp-cert.pem -days 730 -subj "/CN=<YOUR_DOMAIN e.g. saml.gorbit.dev>"
awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' sp-cert.pem

انسخ قيمة الشهادة والصقها في sp: x509cert في settings.yaml.

ضبط متغيرات بيئة Gorbit

اضبط متغيرات البيئة التالية في ملف .env أو values.yaml (Docker و Kubernetes، على التوالي).

.env

AUTH_TYPE=saml

إذا كنت تستخدم Docker ولكن ليس لديك ملف .env، انسخ gorbit/deployment/docker_compose/env.prod.template إلى ملف .env جديد في نفس المجلد.

values.yaml

configMap:
  AUTH_TYPE: saml

​الدليل

الدليل