AntiLdapInjection 1.1.4

dotnet add package AntiLdapInjection --version 1.1.4                
NuGet\Install-Package AntiLdapInjection -Version 1.1.4                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AntiLdapInjection" Version="1.1.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AntiLdapInjection --version 1.1.4                
#r "nuget: AntiLdapInjection, 1.1.4"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AntiLdapInjection as a Cake Addin
#addin nuget:?package=AntiLdapInjection&version=1.1.4

// Install AntiLdapInjection as a Cake Tool
#tool nuget:?package=AntiLdapInjection&version=1.1.4                

Anti-LDAP Injection

NuGet package CI build status CD release status CodeQL Analysis Total alerts

A .NET library that provides protections against LDAP Injection.

Most of the of the code was extracted from Microsoft's AntiXss library LDAP Encoder, which is no longer maintained.

Installation

The latest AntiLdapInjection package is available for installation on NuGet.

Using dotnet CLI

dotnet add package AntiLdapInjection

Using NuGet Package Manager

Install-Package AntiLdapInjection

See NuGet page for additional installation options.

Usage

FilterEncode

FilterEncode encodes input according to RFC 4515, where unsafe values are converted to \XX (XX is the representation of the unsafe character).

LdapEncoder.FilterEncode(string filterToEncode)
FilterEncode encoding chart
Character Encoded
( \28
) \29
\ \5c
* \2a
/ \2f
NUL \0
FilterEncode examples
Opening and closing parenthesis
string filter = "Parens R Us (for all your parenthetical needs)";
string encoded = LdapEncoder.FilterEncode(filter);

Console.WriteLine(encoded); // "Parens R Us \28for all your parenthetical needs\29"
Asterisk in search filter
string filter = "*";
string encoded = LdapEncoder.FilterEncode(filter);

Console.WriteLine(encoded); // "\2A"
Backslash in search filter
string filter = @"C:\MyFile";
string encoded = LdapEncoder.FilterEncode(filter);

Console.WriteLine(encoded); // "C:\5CMyFile"
Accents in search filter
string filter = "Lučić";
string encoded = LdapEncoder.FilterEncode(filter);

Console.WriteLine(encoded); // "Lu\C4\8Di\C4\87"

DistinguishedNameEncode

DistinguishedNameEncode encodes input according to RFC 2253, where unsafe characters are converted to #XX where XX is the representation of the unsafe character and the comma, plus, quote, slash, less than and great than signs are escaped using slash notation (\X). In addition to this, a space or octothorpe (#) at the beginning of the input string is escaped (\), as is a space at the end of a string.

LdapEncoder.DistinguishedNameEncode(string distinguishedNameToEncode)

You have the option to turn off initial or final character escaping rules. For example, if you are concatenating a escaped distinguished name fragment into the midst of a complete distinguished name.

LdapEncoder.DistinguishedNameEncode(
    string distinguishedNameToEncode,
    bool useInitialCharacterRules,
    bool useFinalCharacterRule
)
DistinguishedNameEncode encoding chart
Character Encoded
& \&
! \!
\| \\|
= \=
< \<
> \>
, \,
+ \+
- \-
" \"
' \'
; \;
DistinguishedNameEncode examples
Distinguished name slash notation
string dn = @", + \ "" \ < >";
string encoded = LdapEncoder.DistinguishedNameEncode(dn);

Console.WriteLine(encoded); // "\, \+ \" \\ \< \>"
Leading space in distinguished name
string dn = " Hello";
string encoded = LdapEncoder.DistinguishedNameEncode(dn);

Console.WriteLine(encoded); // "\ Hello"
Trailing space in distinguished name
string dn = "Hello ";
string encoded = LdapEncoder.DistinguishedNameEncode(dn);

Console.WriteLine(encoded); // "Hello\ "
Octothorpe character in distinguished name
string dn = "#Hello";
string encoded = LdapEncoder.DistinguishedNameEncode(dn);

Console.WriteLine(encoded); // "\#Hello"
Accents in distinguished name
string dn = "Lučić";
string encoded = LdapEncoder.DistinguishedNameEncode(dn);

Console.WriteLine(encoded); // "Lu#C4#8Di#C4#87"

LDAP injection resources

Similar libraries

Similar libraries providing protections against LDAP injection, not necessarily in .NET.

Node.js

ldap-escape

ldap-escape is an npm package that provides template literal tag functions for LDAP filters and distinguished names to prevent LDAP injection attacks.

  • LdapForNet: Cross platform port of OpenLdap Client library and Windows LDAP to .NET Core
  • Linq2Ldap: Wrapper around System.DirectoryServices using LINQ Expressions as LDAP filters
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 1.6

  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on AntiLdapInjection:

Package Downloads
Quaero.Ldap

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.4 68,644 5/20/2022
1.1.3 422 5/20/2022
1.1.2 471 5/18/2022
1.1.1 439 5/18/2022
1.1.0 414 1/6/2022
1.0.9 3,898 6/13/2021
1.0.8 388 2/26/2021
1.0.7 595 2/8/2021
1.0.6 390 2/5/2021
1.0.5 367 2/5/2021
1.0.4 379 2/5/2021
1.0.3 357 2/4/2021
1.0.2 352 2/3/2021
1.0.1 389 2/3/2021
1.0.0 381 2/3/2021
1.0.0-pre 252 2/1/2021