Skip to content

Commit

Permalink
Merge pull request #79 from haiwen/update_org_adfs_description
Browse files Browse the repository at this point in the history
update
  • Loading branch information
freeplant authored May 29, 2024
2 parents dde5e61 + 1e17bd2 commit 52188b3
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 26 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 36 additions & 26 deletions en/organization_management/integration_with_ADFS_SAML.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,47 +10,57 @@ If you use Microsoft Azure SAML app to achieve single sign-on, please follow the

**First**, add SAML application and assign users, refer to: [add an Azure AD SAML application](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal), [create and assign users](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal-assign-users)

**Second**, setup your SAML login URL in the Seafile organization admin interface. The format of the login URL is: https://example.com/org/custom/{custom-part}/, e.g.:
**Second**, setup your SAML infomations in the Seafile organization admin interface.

![](../images/auto-upload/8c1988cd-1f66-47c9-ac61-650e8245efcf.png)

**Then**, setup the _Identifier_, _Reply URL_, _Sign on URL_ and _Logout Url_ of the SAML app based on your login URL, refer to: [enable single sign on for saml application](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal-setup-sso). The format of the _Identifier_, _Reply URL_, and _Sign on URL_ are: https://example.com/org/custom/{custom-part}/saml2/metadata/, https://example.com/org/custom/{custom-part}/saml2/acs/, https://example.com/org/custom/{custom-part}/, https://example.com/org/custom/{custom-part}/ls/, e.g.:

![](../images/auto-upload/2a6bdc13-88f8-418b-90e3-cba0a67b12e7.png)
![](./images/auto-upload/8c1988cd-1f66-47c9-ac61-650e8245efcf.png)

__Note__: The {custom-part} of the URL should be 6 to 20 characters, and can only contain alphanumeric characters and hyphens.
**Then**, setup the _Identifier_, _Reply URL_, _Sign on URL_ and _Logout Url_ of the SAML app based by coping the specific URL to the SAML Configuration of your Idp in ADFS, refer to: [enable single sign on for saml application](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal-setup-sso). The format of the _Identifier_, _Reply URL_, and _Sign on URL_ are: https://example.com/org/custom/{org_id}/saml2/metadata/, https://example.com/org/custom/{org_id}/saml2/acs/, https://example.com/org/custom/{org_id}/, https://example.com/org/custom/{org_id}/ls/, e.g.:

![](./images/auto-upload/2a6bdc13-88f8-418b-90e3-cba0a67b12e7.png)

__Note__: The {org_id} of the URL should be the ID of organization, and can only contain integer characters.

**Next**, copy the metadata URL of the SAML app:

![](../images/auto-upload/6702c7c7-a205-4b18-91d2-48dd1a1b7b03.png)
![](./images/auto-upload/6702c7c7-a205-4b18-91d2-48dd1a1b7b03.png)

and paste it into the organization admin interface, e.g:

![](../images/auto-upload/d2252310-0c30-4d88-a553-5711820a65df.png)
![](./images/auto-upload/d2252310-0c30-4d88-a553-5711820a65df.png)

**Next**, download the base64 format SAML app's certificate and rename to idp.crt:

![](../images/auto-upload/3aa0b19d-46ac-426e-adcc-b3869b0a95a1.png)
![](./images/auto-upload/3aa0b19d-46ac-426e-adcc-b3869b0a95a1.png)

Open the idp.crt and copy the content to the organization admin interface:

![](./images/auto-upload/5b3ff455-de3f-4585-93d2-8ecc1c7cc0ea.png)

**Next**, you can verify your domain by create a DNS TXT, and copy it to your domain's DNS records.

![](./images/auto-upload/d88fd998-1382-4b1f-901b-60bb5d874c5a.png)



and upload the idp.crt in the organization admin interface:

![](../images/auto-upload/5b3ff455-de3f-4585-93d2-8ecc1c7cc0ea.png)

**Next**, [edit saml attributes & claims](https://learn.microsoft.com/en-us/azure/active-directory/develop/saml-claims-customization). Keep the default attributes & claims of SAML app unchanged, the _uid_ attribute must be added, the _mail_ and _name_ attributes are optional, e.g.:

![](../images/auto-upload/abee9c69-f03d-4735-9231-92bd923b9ceb.png)
![](./images/auto-upload/abee9c69-f03d-4735-9231-92bd923b9ceb.png)

**Finally**, open the browser and enter the Seafile login page, click `Single Sign-On`, e.g.

![](../images/auto-upload/d88fd998-1382-4b1f-901b-60bb5d874c6e.png)
![](./images/auto-upload/d88fd998-1382-4b1f-901b-60bb5d874c6e.png)

in the new page, enter your email address ending with the company domain name, e.g.

![](../images/auto-upload/bfd4a31c-2533-435d-9231-7f187117a139.png)
![](./images/auto-upload/bfd4a31c-2533-435d-9231-7f187117a139.png)

Click the `Log In` button will jump to the SAML app login page, e.g.:

![](../images/auto-upload/21dc07ae-89a7-4281-be18-566a64bca922.png)
![](./images/auto-upload/21dc07ae-89a7-4281-be18-566a64bca922.png)

## Integration with on-premise ADFS

Expand All @@ -64,21 +74,21 @@ If you use Microsoft ADFS to achieve single sign-on, please follow the steps bel

3. A valid SSL certificate for Seafile server, and here we use `demo.seafile.com` as the domain name example.

**Second**, setup your ADFS login URL in the Seafile organization admin interface. The format of the login URL is: `https://example.com/org/custom/{custom-part}/`, e.g.:
**Second**, setup your SAML infomations in the Seafile organization admin interface, and use these values to configure your identity Provider.

![](../images/auto-upload/8c1988cd-1f66-47c9-ac61-650e8245efcf.png)
![](./images/auto-upload/8c1988cd-1f66-47c9-ac61-650e8245efcf.png)

**Next**, setup the federation metadata URL of Microsoft ADFS in the organization admin interface. The format of the federation metadata URL is: `https://{your ADFS domain name}/federationmetadata/2007-06/federationmetadata.xml`, e.g:

![](../images/auto-upload/bde53e1b-dfef-4693-bba8-8ec8801627d6.png)
![](./images/auto-upload/bde53e1b-dfef-4693-bba8-8ec8801627d6.png)

**Next**, download the base64 format certificate and upload it:
**Next**, download the base64 format certificate and copy the content to the certificate field:

* Navigate to the _AD FS_ management window. In the left sidebar menu, navigate to **Services** > **Certificates**.

* Locate the _Token-signing_ certificate. Right-click the certificate and select **View Certificate**.

![](../images/auto-upload/7a1eead2-272f-40ec-9768-effc1d4f3273.png)
![](./images/auto-upload/7a1eead2-272f-40ec-9768-effc1d4f3273.png)

* In the dialog box, select the **Details** tab.

Expand All @@ -94,7 +104,7 @@ If you use Microsoft ADFS to achieve single sign-on, please follow the steps bel

* And then upload the idp.crt in the organization admin interface:

![](../images/auto-upload/7f2b4010-5f50-4184-9d56-fe60d5a5809e.png)
![](./images/auto-upload/7f2b4010-5f50-4184-9d56-fe60d5a5809e.png)

**Next**, add [relying party trust](https://learn.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust#to-create-a-claims-aware-relying-party-trust-using-federation-metadata):

Expand All @@ -104,9 +114,9 @@ If you use Microsoft ADFS to achieve single sign-on, please follow the steps bel

* On the Welcome page, choose **Claims aware** and click **Start**.

* Select **Import data about the relying party published online or on a local network**, type your organization metadate url in **Federation metadata address (host name or URL)**, and then click **Next**. Your organization metadate url format is: `https://example.com/org/custom/{custom-part}/saml2/metadata/`, e.g.:
* Select **Import data about the relying party published online or on a local network**, type your organization metadate url in **Federation metadata address (host name or URL)**, and then click **Next**. Your organization metadate url format is: `https://example.com/org/custom/{org_id}/saml2/metadata/`, e.g.:

![](../images/auto-upload/e343f174-e31c-4aba-8f26-2b78927f625c.png)
![](./images/auto-upload/e343f174-e31c-4aba-8f26-2b78927f625c.png)

* On the **Specify Display Name** page type a name in **Display name**, e.g. `Seafile`, under **Notes** type a description for this relying party trust, and then click **Next**.

Expand Down Expand Up @@ -140,12 +150,12 @@ __Note__: When creating claims rule, you can also select other LDAP Attributes,

**Next**, configure the logout page, e.g.:

![](../images/auto-upload/0beb35c6-89ef-4e8c-8956-9b3c74f50aa8.png)
![](./images/auto-upload/0beb35c6-89ef-4e8c-8956-9b3c74f50aa8.png)

![](../images/auto-upload/3a3281c6-eb25-41c3-b2bb-94d7f9d22eec.png)
![](./images/auto-upload/3a3281c6-eb25-41c3-b2bb-94d7f9d22eec.png)

The format of the logout URL is: `https://example.com/org/custom/{custom-part}/saml2/ls/`, e.g.:
The format of the logout URL is: `https://example.com/org/custom/{org_id}/saml2/ls/`, e.g.:

![](../images/auto-upload/1e6326f5-60eb-4720-8e55-c92f6c2f5f68.png)
![](./images/auto-upload/1e6326f5-60eb-4720-8e55-c92f6c2f5f68.png)

**Finally**, open the browser and enter the Seafile login page, click `Single Sign-On`. In the new page, enter your email address ending with the company domain name, click the `Log In` button will jump to the ADFS login page.

0 comments on commit 52188b3

Please sign in to comment.