Installation

The product is supplied as a ZIP file. This includes the NuGet packages, documentation and example projects. Simply unzip to a convenient location on your file system (e.g. C:\SAML for ASP.NET Core).

NuGet Packages

The recommended way to retrieve the SAML for ASP.NET Core packages and stay up to date is via nuget.org.

The following packages are available:

Package	Purpose	Notes
ComponentSpace.Saml2	SAML functionality	Required
ComponentSpace.Saml2.Configuration.Database	Store SAML configuration in an Entity Framework database	Optional
ComponentSpace.Saml2.XmlSecurity.RsaOaep	RSA-OAEP encryption of symmetric keys	Optional

Package Updates and License Period

Your license entitles you to use only versions of the product that were released during your license period.

If you install or upgrade to a version released after your license period expired, the license will not permit its use and a license error will be reported at runtime.

To avoid this issue:

Ensure the package version you install was released before your license expiry date.
If you require a newer version, renew your license before upgrading.
If you accidentally install a newer version, downgrade the package to a version released within your license period.

Trial Version

The product includes a free 30-day trial period.

Note

Production use requires a commercial license.

Installing the License Key

After purchasing a license, the supplied license key must be installed in the application before deploying to production. It's delivered as a ComponentSpace.lic file.

The installation options are:

Copy the ComponentSpace.lic file to the application's root folder. The license key will be loaded automatically.
Copy the ComponentSpace.lic file to a different folder and specify its location at application startup by calling SetSamlLicenseKeyFileName.

For example:
```
builder.Services
    .AddSaml(builder.Configuration.GetSection("SAML"))
    .SetSamlLicenseKeyFileName(@"Licenses\ComponentSpace.lic");
```

Copy the license key string from the ComponentSpace.lic file and set it at application startup by calling SetSamlLicenseKey.

For example:

builder.Services
    .AddSaml(builder.Configuration.GetSection("SAML"))
    .SetSamlLicenseKey("license key string goes here...");

Store the license key string elsewhere (e.g. in an environment variable or the app settings), retrieve it and set it at application startup by calling SetSamlLicenseKey.

Note

The license key is safe to store and distribute as required. It's specific to your organization but doesn't contain any sensitive or personally identifiable information.

Renewing the License Key

When you renew your license, you receive a new license key with a new license period.

To take advantage of newer product versions released during your new license period, you must replace the previous license key with the new license key.

However, you do not need to update the license key in an existing production deployment simply because you have renewed. Your existing production deployment can continue using the previous license key with the product version currently deployed.

This means that renewing your license does not require an immediate production change. You can renew your license, update your development environment with the new license key, and then upgrade your production systems when it suits your release schedule.

Uninstallation

Uninstall the ComponentSpace.Saml2 packages from any ASP.NET Core web application projects.
Delete the unzipped product folder from your file system.