پیکربندی Okta SSO

TestRail به شما امکان می‌دهد با استفاده از پروتکل‌های SAML ۲.۰، OAuth ۲.۰ و OpenID Connect به identity provider دلخواهتان برای SSO یا همان IDP متصل شوید. بعد از فعال‌کردن پیکربندی SSO، می‌توانید پروتکل موردنظر خود را انتخاب کنید.

این راهنما به‌طور مشخص برای پیکربندی Okta است. ابتدا برای ثبت web application در Okta مراحل زیر را انجام دهید:

1. با حساب administrator خود وارد سازمان Okta شوید.
2. در Admin Console ، به مسیر Applications > Applications بروید. این گزینه در پنل سمت چپ قرار دارد.
3. روی Create App Integration کلیک کنید.
4. یک app integration جدید بسازید: 
   1. Sign-on method: گزینه زیر را انتخاب کنید OIDC – OpenID Connect.
   2. Application type: گزینه زیر را انتخاب کنید Web Application.
   3. روی Next کلیک کنید. Application شما ثبت می‌شود و برای تنظیم جزئیات آن به صفحه بعد هدایت می‌شوید.
5. New Web App Integration:
   1. App integration name: یک نام برای app integration جدید وارد کنید.
   2. Grant type: Authorization Code باید انتخاب شده باشد؛ این گزینه بالاترین سطح امنیت را فراهم می‌کند.
   3. Sign-in redirect URLs این بخش نباید خالی بماند. در این قسمت باید redirect URL مربوط به انتقال کاربر بعد از authorization را وارد کنید. این URL باید همان مقداری باشد که در صفحه تنظیمات SSO برای OAuth و OpenID آمده است. می‌توانید redirect URL را در صفحه پیکربندی SSO، زیر برچسب «Single Sign On URL» پیدا کنید.
      مثال: http://${domain}/testrail/index.php?/auth/redirect_oidc_acs
   4. Sign-out redirect URL اختیاری:  https://{domain}/index.php
   5. هر اطلاعات تکمیلی دیگری را وارد کنید و روی Save.
6. برای دریافت client credentials مربوط به app integration خود:
   1. در تب General ، Client ID را از بخش Client Credentials کپی کنید. 
   2. سپس Client secret را از بخش Client Credentials کپی کنید. 
   3. در ادامه Okta domain را از بخش General Settings کپی کنید.
7. فعال‌سازی Consent Screen در Okta:
   1. از پنل سمت چپ به Security -> API -> بروید.
   2. روی Default کلیک کنید.
   3. به تب Scopes بروید.
   4. OpenID را ویرایش کنید: User consent را تیک بزنید و ذخیره کنید.
   5. موارد Profile و email را ویرایش کنید: User consent را تیک بزنید و ذخیره کنید.

پیکربندی SSO در Okta – OpenID Connect #

1. با دسترسی administrator وارد TestRail شوید.
2. به مسیر Admin > Site Settings > SSO بروید.
3. گزینه Your Authentication Protocol: OpenID Connect را انتخاب کنید.
4. Single Sign On URL: این فیلد از قبل با مقادیری پر شده که هنگام ثبت application جدید، برای تنظیم redirect URL استفاده می‌شوند.
5. وارد حساب Okta خود شوید و application خود را باز کنید تا اطلاعات لازم برای مراحل بعدی را بردارید.
6. به TestRail برگردید. برای Client ID، Application (client) ID را از Client Credentials در Okta، بخش General کپی کنید و در این فیلد قرار دهید.
7. Client Secret: مقدار client secret را از فیلد Value در Client Credentials در Okta، بخش General tab کپی کنید و در این فیلد قرار دهید.
8. IDP Issuer URL: دامنه Okta را از General Settings کپی کنید و این URL را کامل کنید: https://${yourOktaDomain}/oauth2/default/
9. Create Account on First Login: این تنظیم را فعال کنید تا اگر کاربر با موفقیت احراز هویت شد، TestRail به‌صورت خودکار برای او حساب کاربری جدید بسازد.
10. Whitelist Domains: برای جلوگیری از درخواست‌های سازمان‌های غیرمجاز، می‌توانید ساخت حساب جدید را به دامنه‌های ایمیل مشخص محدود کنید. در هر خط فقط یک دامنه وارد کنید. (اگر Whitelist Domain خالی باشد، به‌صورت پیش‌فرض همه دامنه‌ها مجاز هستند.)
11. کلیک کنید تنظیمات را ذخیره کنید.
12. تنظیمات تکمیلی پیکربندی را بررسی کنید در ادامه

پیکربندی SSO در Okta – OAuth ۲.۰ #

1. با حساب administrator وارد TestRail شوید.
2. به مسیر Admin > Site Settings > SSO بروید.
3. گزینه Your Authentication Protocol: OAuth 2.0 را انتخاب کنید.
4. Single Sign On URL: این فیلد از قبل با مقادیری پر شده است که هنگام ثبت دوباره application برای تنظیم redirect URL استفاده می‌شوند.
5. وارد حساب Okta خود شوید و به application مربوطه بروید تا اطلاعات لازم برای مراحل بعدی را دریافت کنید.
6. در TestRail، برای فیلد Client ID: مقدار Application (client) ID را از Client Credentials در بخش Okta، تب General کپی کنید و در این قسمت قرار دهید.
7. Client Secret: مقدار client secret Value را از Client Credentials در بخش Okta، تب General کپی کنید و در این قسمت قرار دهید.
8. User Authorization URL: دامنه Okta را از بخش General Settings در Okta، تب General کپی کنید و این URL را تکمیل کنید https://${yourOktaDomain}/oauth2/default/v1/authorize
9. Access Token URL: دامنه Okta را از بخش General Settings در Okta General tab کپی کنید و این URL را وارد کنید https://${yourOktaDomain}/oauth2/default/v1/token  
10. User Info URL: دامنه Okta را از بخش General Settings در Okta General tab کپی کنید و این URL را وارد کنید https://${yourOktaDomain}/oauth2/default/v1/userinfo
11. Create Account on First Login: این تنظیم را فعال کنید تا مشخص شود اگر کاربر با موفقیت احراز هویت شد، TestRail به‌صورت خودکار برای او حساب کاربری جدید در TestRail ایجاد کند یا نه.
12. Whitelist Domains: برای جلوگیری از درخواست‌های سازمان‌های غیرمجاز، می‌توانید ایجاد حساب جدید را به دامنه‌های ایمیل مشخص محدود کنید. کافی است در هر خط یک دامنه وارد کنید. (اگر Whitelist Domain خالی باشد، به‌صورت پیش‌فرض همه دامنه‌ها مجاز هستند).
13. روی Save Settings کلیک کنید.
14. تنظیمات تکمیلی پیکربندی را در ادامه بررسی کنید

مراحل تکمیلی پیکربندی SSO در Okta، فقط برای پروتکل‌های OpenID Connect و OAuth ۲.۰ فقط
#

طبق آنچه Okta در مقاله خود منتشر کرده است ، برای instanceهایی که از پروتکل‌های OpenID و OAuth استفاده می‌کنند، مراحل تکمیلی زیر نیز باید پیکربندی شوند:

1. پورتال مدیریت Okta را باز کنید
2. باز کنید Security → API صفحه بروید و در Authorization Servers tab، روی دکمه Edit کنار authorization server خود کلیک کنید
3. در صفحه بازشده به Access Policies tab بروید و روی دکمه Add Policy کلیک کنید
4. فیلدهای Name ، Description را تکمیل کنید و روی Create Policy
5. در policy جدیدی که ایجاد شده، روی دکمه Add Rule کلیک کنید
6. در dialog بازشده، فیلد Rule Name را تکمیل کنید. سایر تنظیمات را می‌توانید بدون تغییر بگذارید یا در صورت نیاز تغییر دهید، سپس روی دکمه Create Rule کلیک کنید.

پیکربندی SSO در Okta – SAML ۲.۰ #

1. در Okta، با حساب administrator وارد شوید و به بخش Admin > Applications بروید.
2. روی دکمه Add Application کلیک کنید.
3. روی دکمه Create New App کلیک کنید، SAML 2.0 را انتخاب کنید و سپس با کلیک روی دکمه Create کلیک کنید.
4. برای app یک نام انتخاب کنید (مثلا TestRail) و اگر خواستید، یک لوگو هم upload کنید.
5. روی Next کلیک کنید.
6. وارد TestRail شوید و به صفحه SSO در کنسول Admin > Settings بروید.
7. مقدار Entity ID را از صفحه پیکربندی SSO در TestRail کپی کنید و در فیلد Okta Audience URL (SP Entity ID) قرار دهید.
8. مقدار Single Sign On URL را از صفحه پیکربندی SSO در TestRail کپی کنید و در فیلد Okta Single sign-on URL قرار دهید.
9. گزینه Use this for Recipient URL and Destination URL را در Okta به حالت انتخاب‌شده نگه دارید.
10. فیلدهای Name ID format و Application Username را می‌توانید نادیده بگیرید.
11. در Okta، Attribute Statements را به شکل زیر تنظیم کنید:
    

    Attribute Name	Attribute Value
    FirstName	user.firstName
    LastName	user.lastName
    Email	user.email

      #

    مقادیر بالا به بزرگ و کوچک بودن حروف حساس هستند.

12. در Okta روی Next کلیک کنید و پرسشنامه یا فیلدهای باقی‌مانده دیگر را طبق نیاز تکمیل کنید.
13. پس از انجام این کار، یا در تب Sign On در Okta، روی دکمه View Setup Instructions کلیک کنید تا URLهای موردنیاز و certificate مربوط به TestRail نمایش داده شود.
14. مقادیر Identity Provider Single Sign-On URL و Identity Provider Issuer URL را از Okta کپی کنید و در فیلدهای TestRail IDP SSO URL و IDP Issuer URL به‌ترتیب وارد کنید.
15. گواهی X.۵۰۹ را از Okta کپی و در TestRail پیست کنید، یا آن را دانلود کرده و سپس آپلود کنید.
16. روی Save کلیک کنید. اتصال را تست کنید تا مطمئن شوید تنظیمات درست هستند.
17. تا زمانی که administrator مورد استفاده برای پیکربندی تنظیمات در TestRail به appای که در Okta ساخته‌اید اختصاص داده شده باشد، تست اتصال باید موفق شود و می‌توانید از TestRail در حالت Single Sign-On (SSO) استفاده کنید.