Skip to content

Commit

Permalink
Update package version.
Browse files Browse the repository at this point in the history
Added docs for Visus.Ldap.Core.
  • Loading branch information
crowbar27 committed Aug 1, 2024
1 parent 488414e commit 830798c
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 7 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ Version 2.0 is a major rewrite of both libraries, which removes previously depre
1. In your LDAP options section in appsettings.json, make sure to change "SearchBase" to "SearchBases" and provide a map from the DN to the search scope.
1. In your LDAP options section in appsettings.json, make sure to replace "IsSsl" with the equivalent "TransportSecurity". **"IsSsl" is not honoured anymore! Without "TransportSecurity", your connections will not be encrypted!**
1. In your startup code, replace all previous dependency injection extension methods with a version of `AddLdapAuthentication`. The template parameters allow you to change the type of user and group that the LDAP entries are mapped to.
1. In your code, change all services to include the user and/or group type you want to use.
1. In your code, change all services to include the user and/or group type you want to use as generic parameters of the service interfaces.
1. In your code, update the `using` statements. Some shared classes like `LdapUser` have been moved from the `Visus.DirectoryAuthentication` and `Visus.LdapAuthentication` namespaces to the shared `Visus.Ldap` namespace. Furthermore, the namespaces are now structured to isolate LDAP mapping, claims mapping, etc.
1. In your code, replace `ILdapAuthenticationService.Login` with `ILdapAuthenticationService.LoginUser` or `ILdapAuthenticationService.LoginPrincipal` depending on your needs.
1. If you use `LdapAttributeAttribute.GetLdapAttribute` to reflect on LDAP attribute mappings in your code, inject `ILdapAttributeMap<LdapUserOrGroup>` to obtain similar information. `ILdapAttributeMap`s provide direct access to attribute names and `PropertyInfo`s and are more efficient than the previous on-demand reflection.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
<PackageProjectUrl>https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication/tree/main/Visus.DirectoryAuthentication</PackageProjectUrl>
<RepositoryUrl>https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication</RepositoryUrl>
<PackageTags>directoryservices ldap aspnet authentication net5</PackageTags>
<PackageReleaseNotes>Ignores IsSsl except for Windows due to https://github.com/dotnet/runtime/issues/43890</PackageReleaseNotes>
<PackageReleaseNotes>A major update of the API removing legacy features and streamlining LDAP attribute and claims mapping.</PackageReleaseNotes>
<PackageReadmeFile>README.md</PackageReadmeFile>
<NeutralLanguage>en</NeutralLanguage>
<UserSecretsId>e07a7441-ba97-46b5-9ce1-391f2c978578</UserSecretsId>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Version>2.0.0-pre5</Version>
<Version>2.0.0</Version>
<Nullable>enable</Nullable>
</PropertyGroup>

Expand Down
2 changes: 2 additions & 0 deletions Visus.Ldap.Core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Visus.Ldap.Core
This library implements shared functionality for [Visus.DirectoryAuthentication](https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication/tree/main/Visus.DirectoryAuthentication) and [Visus.LdapAuthentication](https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication/tree/main/Visus.LdapAuthentication). It has barely any use without one of these libaries and should not be installed independently.
11 changes: 10 additions & 1 deletion Visus.Ldap.Core/Visus.Ldap.Core.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
<RepositoryUrl>https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication</RepositoryUrl>
<RootNamespace>Visus.Ldap</RootNamespace>
<Title>LDAP authentication base classes</Title>
<Version>2.0.0-pre5</Version>
<Version>2.0.0</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageReleaseNotes>Initial release of the library.</PackageReleaseNotes>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand All @@ -39,4 +41,11 @@
</EmbeddedResource>
</ItemGroup>

<ItemGroup>
<None Update="README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions Visus.LdapAuthentication/Visus.LdapAuthentication.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@
<RepositoryUrl>https://github.com/UniStuttgart-VISUS/Visus.LdapAuthentication</RepositoryUrl>
<PackageTags>ldap aspnet authentication net5</PackageTags>
<NeutralLanguage>en</NeutralLanguage>
<Version>2.0.0-pre5</Version>
<PackageReleaseNotes>Adds the ability to customise the mapping of user objects by means of an external mapper rather than by modifying the user.
Adds the ability to retrieve the default naming context from an LDAP connection.</PackageReleaseNotes>
<Version>2.0.0</Version>
<PackageReleaseNotes>A major update of the API removing legacy features and streamlining LDAP attribute and claims mapping.</PackageReleaseNotes>
<PackageReadmeFile>README.md</PackageReadmeFile>
<Nullable>enable</Nullable>
</PropertyGroup>
Expand Down

0 comments on commit 830798c

Please sign in to comment.