Skip to content

Commit b06554a

Browse files
committed
doc: add info about resolveTlsa
1 parent ee38cdc commit b06554a

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

doc/api/dns.md

+71
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ The following methods from the `node:dns` module are available:
129129
* [`resolver.resolvePtr()`][`dns.resolvePtr()`]
130130
* [`resolver.resolveSoa()`][`dns.resolveSoa()`]
131131
* [`resolver.resolveSrv()`][`dns.resolveSrv()`]
132+
* [`resolver.resolveTlsa()`][`dns.resolveTlsa()`]
132133
* [`resolver.resolveTxt()`][`dns.resolveTxt()`]
133134
* [`resolver.reverse()`][`dns.reverse()`]
134135
* [`resolver.setServers()`][`dns.setServers()`]
@@ -444,6 +445,7 @@ records. The type and structure of individual results varies based on `rrtype`:
444445
| `'PTR'` | pointer records | {string} | [`dns.resolvePtr()`][] |
445446
| `'SOA'` | start of authority records | {Object} | [`dns.resolveSoa()`][] |
446447
| `'SRV'` | service records | {Object} | [`dns.resolveSrv()`][] |
448+
| `'TLSA'` | certificate associations | {Object} | [`dns.resolveTlsa()`][] |
447449
| `'TXT'` | text records | {string\[]} | [`dns.resolveTxt()`][] |
448450

449451
On error, `err` is an [`Error`][] object, where `err.code` is one of the
@@ -543,6 +545,7 @@ will be present on the object:
543545
| `'PTR'` | `value` |
544546
| `'SOA'` | Refer to [`dns.resolveSoa()`][] |
545547
| `'SRV'` | Refer to [`dns.resolveSrv()`][] |
548+
| `'TLSA'` | Refer to [`dns.resolveTlsa()`][] |
546549
| `'TXT'` | This type of record contains an array property called `entries` which refers to [`dns.resolveTxt()`][], e.g. `{ entries: ['...'], type: 'TXT' }` |
547550

548551
Here is an example of the `ret` object passed to the callback:
@@ -802,6 +805,41 @@ be an array of objects with the following properties:
802805
}
803806
```
804807

808+
## `dns.resolveTlsa(hostname, callback)`
809+
810+
<!-- YAML
811+
added: REPLACEME
812+
-->
813+
814+
<!--lint disable no-undefined-references list-item-bullet-indent-->
815+
816+
* `hostname` {string}
817+
* `callback` {Function}
818+
* `err` {Error}
819+
* `records` {Object\[]}
820+
821+
<!--lint enable no-undefined-references list-item-bullet-indent-->
822+
823+
Uses the DNS protocol to resolve certificate associations (`TLSA` records) for
824+
the `hostname`. The `records` argument passed to the `callback` function is an
825+
array of objects with these properties:
826+
827+
* `certUsage`
828+
* `selector`
829+
* `match`
830+
* `data`
831+
832+
<!-- eslint-skip -->
833+
834+
```js
835+
{
836+
certUsage: 3,
837+
selector: 1,
838+
match: 1,
839+
data: [ArrayBuffer]
840+
}
841+
```
842+
805843
## `dns.resolveTxt(hostname, callback)`
806844

807845
<!-- YAML
@@ -1008,6 +1046,7 @@ The following methods from the `dnsPromises` API are available:
10081046
* [`resolver.resolvePtr()`][`dnsPromises.resolvePtr()`]
10091047
* [`resolver.resolveSoa()`][`dnsPromises.resolveSoa()`]
10101048
* [`resolver.resolveSrv()`][`dnsPromises.resolveSrv()`]
1049+
* [`resolver.resolveTlsa()`][`dnsPromises.resolveTlsa()`]
10111050
* [`resolver.resolveTxt()`][`dnsPromises.resolveTxt()`]
10121051
* [`resolver.reverse()`][`dnsPromises.reverse()`]
10131052
* [`resolver.setServers()`][`dnsPromises.setServers()`]
@@ -1212,6 +1251,7 @@ based on `rrtype`:
12121251
| `'PTR'` | pointer records | {string} | [`dnsPromises.resolvePtr()`][] |
12131252
| `'SOA'` | start of authority records | {Object} | [`dnsPromises.resolveSoa()`][] |
12141253
| `'SRV'` | service records | {Object} | [`dnsPromises.resolveSrv()`][] |
1254+
| `'TLSA'` | certificate associations | {Object} | [`dnsPromises.resolveTlsa()`][] |
12151255
| `'TXT'` | text records | {string\[]} | [`dnsPromises.resolveTxt()`][] |
12161256

12171257
On error, the `Promise` is rejected with an [`Error`][] object, where `err.code`
@@ -1276,6 +1316,7 @@ present on the object:
12761316
| `'PTR'` | `value` |
12771317
| `'SOA'` | Refer to [`dnsPromises.resolveSoa()`][] |
12781318
| `'SRV'` | Refer to [`dnsPromises.resolveSrv()`][] |
1319+
| `'TLSA'` | Refer to [`dnsPromises.resolveTlsa()`][] |
12791320
| `'TXT'` | This type of record contains an array property called `entries` which refers to [`dnsPromises.resolveTxt()`][], e.g. `{ entries: ['...'], type: 'TXT' }` |
12801321

12811322
Here is an example of the result object:
@@ -1458,6 +1499,34 @@ the following properties:
14581499
}
14591500
```
14601501

1502+
### `dnsPromises.resolveTlsa(hostname)`
1503+
1504+
<!-- YAML
1505+
added: REPLACEME
1506+
-->
1507+
1508+
* `hostname` {string}
1509+
1510+
Uses the DNS protocol to resolve certificate associations (`TLSA` records) for
1511+
the `hostname`. On success, the `Promise` is resolved with an array of objects
1512+
with these properties:
1513+
1514+
* `certUsage`
1515+
* `selector`
1516+
* `match`
1517+
* `data`
1518+
1519+
<!-- eslint-skip -->
1520+
1521+
```js
1522+
{
1523+
certUsage: 3,
1524+
selector: 1,
1525+
match: 1,
1526+
data: [ArrayBuffer]
1527+
}
1528+
```
1529+
14611530
### `dnsPromises.resolveTxt(hostname)`
14621531

14631532
<!-- YAML
@@ -1658,6 +1727,7 @@ uses. For instance, they do not use the configuration from `/etc/hosts`.
16581727
[`dns.resolvePtr()`]: #dnsresolveptrhostname-callback
16591728
[`dns.resolveSoa()`]: #dnsresolvesoahostname-callback
16601729
[`dns.resolveSrv()`]: #dnsresolvesrvhostname-callback
1730+
[`dns.resolveTlsa()`]: #dnsresolvetlsahostname-callback
16611731
[`dns.resolveTxt()`]: #dnsresolvetxthostname-callback
16621732
[`dns.reverse()`]: #dnsreverseip-callback
16631733
[`dns.setDefaultResultOrder()`]: #dnssetdefaultresultorderorder
@@ -1676,6 +1746,7 @@ uses. For instance, they do not use the configuration from `/etc/hosts`.
16761746
[`dnsPromises.resolvePtr()`]: #dnspromisesresolveptrhostname
16771747
[`dnsPromises.resolveSoa()`]: #dnspromisesresolvesoahostname
16781748
[`dnsPromises.resolveSrv()`]: #dnspromisesresolvesrvhostname
1749+
[`dnsPromises.resolveTlsa()`]: #dnspromisesresolvetlsahostname
16791750
[`dnsPromises.resolveTxt()`]: #dnspromisesresolvetxthostname
16801751
[`dnsPromises.reverse()`]: #dnspromisesreverseip
16811752
[`dnsPromises.setDefaultResultOrder()`]: #dnspromisessetdefaultresultorderorder

0 commit comments

Comments
 (0)