Authentication/SAML: Difference between revisions

No edit summary
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:
__FORCETOC__
__FORCETOC__
<div class="col-md-12 ibox-content">
<div class="col-md-12 ibox-content">
= SAML Readme =
= Zimbra Single Sign-On using SAML with SimpleSAMLphp =
{{KB|{{Unsupported}}|{{ZCS 8.0}}|{{ZCS 7.0}}|}}
{{KB||{{ZCS 9.0}}|{{ZCS 10.0}}|}}
{{WIP}}
 
[[Category:Authentication]]
[[Category:Authentication]]
[[Category:Administration]]
[[Category:Administration]]
[[Category:Configuration]]
[[Category:Configuration]]


Included in Network Edition at the following location:
Did you know that Zimbra support SAML single sign on? SAML is an open standard that allows you to have a single login page for all applications in your organization. SAML is a Zimbra Network Edition feature. Once you have set-up your SAML portal you can easily add Multi Factor Authentication.
 
/opt/zimbra/extensions-network-extra/saml/README.txt
 
<pre>
 
The Zimbra SAML extension provides support for the "Browser/POST Profile of SAML" - Section 4.1.2 of
http://www.oasis-open.org/committees/download.php/3405/oasis-sstc-saml-bindings-1.1.pdf. Zimbra is the "Destination
Site" in the context of this section of the spec.
 
The flow for a user on a browser would be:
 
1. User authenticates with an IdP which can act as a SAML Provider.
2. The IdP redirects the browser to Zimbra SAML extension URL (<zimbra_base_url>/service/extension/samlreceiver) and
  passes along a SAML Response (containing a SAML Assertion).
3. The SAML extension checks the validity of the SAML Response, and then looks up the Subject inside the SAML assertion
  which should be the email address corresponding to user's Zimbra account.
4. Finally, a Zimbra cookie corresponding to that Zimbra account is returned to the browser and is redirected to the
  default Zimbra mail URL.
 
 
Zimbra Setup
------------
 
- Create "saml" directory under /opt/zimbra/lib/ext; Copy samlextn.jar under it.


- Add the SAML signing certificate to the domain:
== Set up Zimbra SP in SimpleSAMLphp ==


    zmprov md <domain> zimbraMyoneloginSamlSigningCert <saml-signing-cert-base64-data>
See the following links that are updated regularly:


https://blog.zimbra.com/2021/03/updated-saml-for-zimbra-now-supports-single-log-out/


Note for SAML Provider
https://blog.zimbra.com/2021/05/zimbra-skillz-zimbra-with-on-premises-single-sign-on-using-simplesamlphp/
----------------------


SAML Provider must POST the SAML Response at the following URL for SSO:
https://blog.zimbra.com/2020/02/zimbra-and-single-sign-on-using-saml/


    <zimbra_base_url>/service/extension/samlreceiver
Keycloak: https://github.com/Zimbra/keycloak


This SAML Consumer extension requires that the Subject Name Identifier inside the SAML Assertion must be the account
Google Workspaces: https://github.com/Zimbra/google-workspaces-saml
email address, so configure the Provider accordingly.


</pre>
Cisco Duo: https://github.com/Zimbra/cisco-duo-saml


== Troubleshooting ==
== Zimbra FOSS SAML ==
* Check /opt/zimbra/log/zmmailboxd.out for exceptions - it's more useful than mailbox.log in this case


* In 8.7.11, set zimbraCsrfRefererCheckEnabled to FALSE or add the domain to zimbraCsrfAllowedRefererHosts. Setting it to FALSE is preferred.
https://gallery.zetalliance.org/extend/items/view/zimbra-single-sign-on-saml


* Also in 8.7.11, we've seen the existing certificate stored in 'zimbraMyOneLoginSamlSigningCert' doesn't load in certain situations, especially after an upgrade. To fix this, we'll simply have to reload the certificate.
{{Article Footer|Zimbra 9|02/22/2021}}
To do this, either get a copy of the certificate, or recreate it from the output of:
zmprov gd example.com zimbraMyOneLoginSigningCert
After that, null the value:
zmprov md example.com zimbraMyOneLoginSigningCert ' '
And then set it to the new certificate.
{{Article Footer|Zimbra Collaboration 8.0, 7.0|04/16/2014}}

Revision as of 06:12, 10 March 2023

Zimbra Single Sign-On using SAML with SimpleSAMLphp

   KB 20404        Last updated on 2023-03-10  




5.00
(one vote)

Did you know that Zimbra support SAML single sign on? SAML is an open standard that allows you to have a single login page for all applications in your organization. SAML is a Zimbra Network Edition feature. Once you have set-up your SAML portal you can easily add Multi Factor Authentication.

Set up Zimbra SP in SimpleSAMLphp

See the following links that are updated regularly:

https://blog.zimbra.com/2021/03/updated-saml-for-zimbra-now-supports-single-log-out/

https://blog.zimbra.com/2021/05/zimbra-skillz-zimbra-with-on-premises-single-sign-on-using-simplesamlphp/

https://blog.zimbra.com/2020/02/zimbra-and-single-sign-on-using-saml/

Keycloak: https://github.com/Zimbra/keycloak

Google Workspaces: https://github.com/Zimbra/google-workspaces-saml

Cisco Duo: https://github.com/Zimbra/cisco-duo-saml

Zimbra FOSS SAML

https://gallery.zetalliance.org/extend/items/view/zimbra-single-sign-on-saml

Verified Against: Zimbra 9 Date Created: 02/22/2021
Article ID: https://wiki.zimbra.com/index.php?title=Authentication/SAML Date Modified: 2023-03-10



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »


Jump to: navigation, search