|
| 1 | +.. image:: https://odoo-community.org/readme-banner-image |
| 2 | + :target: https://odoo-community.org/get-involved?utm_source=readme |
| 3 | + :alt: Odoo Community Association |
| 4 | + |
| 5 | +==================== |
| 6 | +SAML2 Authentication |
| 7 | +==================== |
| 8 | + |
| 9 | +.. |
| 10 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 11 | + !! This file is generated by oca-gen-addon-readme !! |
| 12 | + !! changes will be overwritten. !! |
| 13 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 14 | + !! source digest: sha256:3e5b3bb4044a255d619b8bda0861d58722133ab48366ffd2c2f88c8fbdcc0a5c |
| 15 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 16 | +
|
| 17 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 18 | + :target: https://odoo-community.org/page/development-status |
| 19 | + :alt: Beta |
| 20 | +.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png |
| 21 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 22 | + :alt: License: AGPL-3 |
| 23 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github |
| 24 | + :target: https://github.com/OCA/server-auth/tree/19.0/auth_saml |
| 25 | + :alt: OCA/server-auth |
| 26 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 27 | + :target: https://translation.odoo-community.org/projects/server-auth-19-0/server-auth-19-0-auth_saml |
| 28 | + :alt: Translate me on Weblate |
| 29 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 30 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-auth&target_branch=19.0 |
| 31 | + :alt: Try me on Runboat |
| 32 | + |
| 33 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 34 | + |
| 35 | +Let users log into Odoo via an SAML2 identity provider. |
| 36 | + |
| 37 | +This module allows to deport the management of users and passwords in an |
| 38 | +external authentication system to provide SSO functionality (Single Sign |
| 39 | +On) between Odoo and other applications of your ecosystem. |
| 40 | + |
| 41 | +**Benefits**: |
| 42 | + |
| 43 | +- Reducing the time spent typing different passwords for different |
| 44 | + accounts. |
| 45 | +- Reducing the time spent in IT support for password oversights. |
| 46 | +- Centralizing authentication systems. |
| 47 | +- Securing all input levels / exit / access to multiple systems without |
| 48 | + prompting users. |
| 49 | +- The centralization of access control information for compliance |
| 50 | + testing to different standards. |
| 51 | + |
| 52 | +**Table of contents** |
| 53 | + |
| 54 | +.. contents:: |
| 55 | + :local: |
| 56 | + |
| 57 | +Installation |
| 58 | +============ |
| 59 | + |
| 60 | +This addon requires the python module ``pysaml2``. |
| 61 | + |
| 62 | +``pysaml2`` requires the binary ``xmlsec1`` (on Debian or Ubuntu you can |
| 63 | +install it with ``apt-get install xmlsec1``) |
| 64 | + |
| 65 | +Configuration |
| 66 | +============= |
| 67 | + |
| 68 | +To use this module, you need an IDP server, properly set up. |
| 69 | + |
| 70 | +1. Configure the module according to your IdP’s instructions (Settings > |
| 71 | + Users & Companies > SAML Providers). |
| 72 | +2. Pre-create your users and set the SAML information against the user. |
| 73 | + |
| 74 | +By default, the module let users have both a password and SAML ids. To |
| 75 | +increase security, disable passwords by using the option in Settings. |
| 76 | +Note that the admin account can still have a password, even if the |
| 77 | +option is activated. Setting the option immediately remove all password |
| 78 | +from users with a configured SAML ids. |
| 79 | + |
| 80 | +If all the users have a SAML id in a single provider, you can set |
| 81 | +automatic redirection in the provider settings. The autoredirection will |
| 82 | +only be done on the active provider with the highest priority. It is |
| 83 | +still possible to access the login without redirection by using the |
| 84 | +query parameter ``disable_autoredirect``, as in |
| 85 | +``https://example.com/web/login?disable_autoredirect=`` The login is |
| 86 | +also displayed if there is an error with SAML login, in order to display |
| 87 | +any error message. |
| 88 | + |
| 89 | +If you are using Office365 as identity provider, set up the federation |
| 90 | +metadata document rather than the document itself. This will allow the |
| 91 | +module to refresh the document when needed. |
| 92 | + |
| 93 | +Usage |
| 94 | +===== |
| 95 | + |
| 96 | +Users can login with the configured SAML IdP with buttons added in the |
| 97 | +login screen. |
| 98 | + |
| 99 | +Known issues / Roadmap |
| 100 | +====================== |
| 101 | + |
| 102 | +- clean up ``auth_saml.request`` |
| 103 | + |
| 104 | +Changelog |
| 105 | +========= |
| 106 | + |
| 107 | +18.0.1.0.3 (2025-09-11) |
| 108 | +----------------------- |
| 109 | + |
| 110 | +Features |
| 111 | +~~~~~~~~ |
| 112 | + |
| 113 | +- When using attribute mapping, only write value that changes. Not |
| 114 | + writing the value systematically avoids getting security mail on |
| 115 | + login/email when there is no real change. |
| 116 | + |
| 117 | +18.0.1.0.2 (2025-05-13) |
| 118 | +----------------------- |
| 119 | + |
| 120 | +Bugfixes |
| 121 | +~~~~~~~~ |
| 122 | + |
| 123 | +- Avoid redirecting when there is a SAML error. |
| 124 | + |
| 125 | +18.0.1.0.0 |
| 126 | +---------- |
| 127 | + |
| 128 | +Initial migration for 18.0. |
| 129 | + |
| 130 | +Bug Tracker |
| 131 | +=========== |
| 132 | + |
| 133 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-auth/issues>`_. |
| 134 | +In case of trouble, please check there if your issue has already been reported. |
| 135 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 136 | +`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20auth_saml%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 137 | + |
| 138 | +Do not contact contributors directly about support or help with technical issues. |
| 139 | + |
| 140 | +Credits |
| 141 | +======= |
| 142 | + |
| 143 | +Authors |
| 144 | +------- |
| 145 | + |
| 146 | +* XCG Consulting |
| 147 | + |
| 148 | +Contributors |
| 149 | +------------ |
| 150 | + |
| 151 | +- `XCG Consulting <https://xcg-consulting.fr/>`__: |
| 152 | + |
| 153 | + - Florent Aide <florent.aide@xcg-consulting.fr> |
| 154 | + - Vincent Hatakeyama <vincent.hatakeyama@xcg-consulting.fr> |
| 155 | + - Alexandre Brun |
| 156 | + - Houzéfa Abbasbhay <houzefa.abba@xcg-consulting.fr> |
| 157 | + - Szeka Wong <szeka.wong@xcg-consulting.fr> |
| 158 | + |
| 159 | +- Jeremy Co Kim Len <jeremy.cokimlen@vinci-concessions.com> |
| 160 | +- Jeffery Chen Fan <jeffery9@gmail.com> |
| 161 | +- Bhavesh Odedra <bodedra@opensourceintegrators.com> |
| 162 | +- `Tecnativa <https://www.tecnativa.com/>`__: |
| 163 | + |
| 164 | + - Jairo Llopis |
| 165 | + |
| 166 | +- `GlodoUK <https://www.glodo.uk/>`__: |
| 167 | + |
| 168 | + - Karl Southern |
| 169 | + |
| 170 | +- `TAKOBI <https://takobi.online/>`__: |
| 171 | + |
| 172 | + - Lorenzo Battistini |
| 173 | + |
| 174 | +Maintainers |
| 175 | +----------- |
| 176 | + |
| 177 | +This module is maintained by the OCA. |
| 178 | + |
| 179 | +.. image:: https://odoo-community.org/logo.png |
| 180 | + :alt: Odoo Community Association |
| 181 | + :target: https://odoo-community.org |
| 182 | + |
| 183 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 184 | +mission is to support the collaborative development of Odoo features and |
| 185 | +promote its widespread use. |
| 186 | + |
| 187 | +.. |maintainer-vincent-hatakeyama| image:: https://github.com/vincent-hatakeyama.png?size=40px |
| 188 | + :target: https://github.com/vincent-hatakeyama |
| 189 | + :alt: vincent-hatakeyama |
| 190 | + |
| 191 | +Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: |
| 192 | + |
| 193 | +|maintainer-vincent-hatakeyama| |
| 194 | + |
| 195 | +This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/19.0/auth_saml>`_ project on GitHub. |
| 196 | + |
| 197 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments