Installing the SAML 2.0 Protocol (aka SAML-P) extension
1. Overview
The Security Assertion Markup Language (SAML) version 2.0 protocol extension adds to Dundas BI's federated authentication functionality, and you may need to install it first if you want to use this protocol with Dundas BI versions 10 and earlier. Other protocols such as OpenID Connect and Microsoft Identity are always included in installations of Dundas BI, and SAML 2.0 is as well in Dundas BI version 11 and higher.
When Dundas BI version 10 or earlier is installed directly onto a server by your organization, the SAML 2.0 Protocol Extension can optionally be downloaded and installed automatically during deployment. If necessary, you can also download the extension and then install it through Dundas BI's interface or use the other installation options described below.
2. Install the extension automatically
Before Dundas BI version 11, the Dundas BI Deployment application on Windows and the deployment wizard for Linux give you the option of downloading and installing the SAML 2.0 extension as part of the installation procedure for the Federated Authentication Module/Bridge. Make sure this option is checked or that you enter y in the wizard when you arrive at that step in the procedure.
If you decide to skip that step, you can install the extension on Windows later from the Deployment application's main screen by clicking Download and install the SAML 2.0 Protocol extension from the Extensions tab, or you can install the extension manually as shown below.
The extension may not be loaded initially. In version 8 and above you can go to the administration interface, expand Setup to click Extensions, and then click to Reload Extensions in the toolbar. When this process is finished and the page refreshes, the SAML2 AuthBridge Protocols extension should be listed. Alternatively, you can recycle the application pool.
3. Download and install the extension manually
You can also install the extension yourself directly into Dundas BI the same way as any other extension.
3.1. Download
Download the version of the extension that is compatible with your version of Dundas BI.
To download the correct extension ZIP file, modify the URL below with the version you are looking to download, and paste into a web browser:
| Framework Version | Dundas BI Version | URL |
|---|---|---|
| .NET Framework | Dundas BI v9 and earlier on Windows | http://www.dundas.com/support/dbi-installer/DBI/Plugins/Saml2Protocol/{Your Dundas BI full version}/Dundas.Saml2Protocol.zip |
| .NET Core | Other Dundas BI versions before v11 | http://www.dundas.com/support/dbi-installer/DBI/Plugins/Saml2Protocol/{Your Dundas BI full version}/Dundas.NetCore.Saml2Protocol.zip |
{Your Dundas BI full version} should be replaced in the URL above. For example, version 9.0.0 Revision 4 would have the following links:
http://www.dundas.com/support/dbi-installer/DBI/Plugins/Saml2Protocol/9.0.0.1004/Dundas.Saml2Protocol.zip http://www.dundas.com/support/dbi-installer/DBI/Plugins/Saml2Protocol/9.0.0.1004/Dundas.NetCore.Saml2Protocol.zip
3.2. Extension installation (versions 8-10)
You can install the extension from Dundas BI's administration interface. Click to expand Setup, click Extensions, and then Add New in the toolbar, where you can click to choose the downloaded extension file. After submitting the dialog, you will then be prompted to reload extensions into the application, or you can click to do so from the toolbar, recycle the application pool, or restart the website service on Linux or your containers.
You can also use the manage extensions command for the dt command line utility. For more information about extension files, see Understanding the Dundas BI extension format.
3.3. Copy files (version 7 and lower)
The download file listed above is a ZIP file. For Dundas BI version 7 and earlier, extract the contents into the installation's App_Data folder. By default, for example, this location is:
C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\www\BIWebsite\App_Data
The following folder structure should now be present (for an instance named Instance1), and the bin folder should contain a series of DLL files:
...\Instance1\www\BIWebsite\App_Data\Extensions\Dundas.Saml2AuthBridgeProtocols\bin\
Note
In version 6 or below, the paths above will be different as the Dundas.Saml2AuthBridgeProtocols parent folder will be an _Authbridge folder. For example:
...\Instance1\www\BIWebsite\App_Data\Extensions\_AuthBridge\Dundas.Saml2AuthBridgeProtocols\bin\
The extension may not be loaded initially until you recycle the application pool or restart the website service on Linux.
4. Licensing and third party legal notices
The SAML 2.0 protocol extension may include the following software licensed under terms that require Dundas Data Visualization, Inc. to display these notices:
Sustainsys.Saml2 (formerly Kentor Authentication Services)
Website: https://github.com/Sustainsys/Saml2
For Dundas BI version 6.0.3 starting from revision 11 (6.0.3.1011), and for version 7.0.2 and later:
MIT License Copyright (c) 2018 Sustainsys AB and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For Dundas BI version 6.0.3.1010 and earlier, and versions 7.0.0-7.0.1:
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
Azure Active Directory IdentityModel Extensions for .NET
Website: https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet
The MIT License (MIT) Copyright (c) Microsoft Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.