https://github.com/silverwind/caa

rfc6844-conform CAA record lookup and validation
https://github.com/silverwind/caa

caa dns letsencrypt module nodejs tls

Last synced: 13 days ago
JSON representation

rfc6844-conform CAA record lookup and validation

• Host: GitHub
• URL: https://github.com/silverwind/caa
• Owner: silverwind
• License: bsd-2-clause
• Created: 2018-08-02T21:27:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T18:55:55.000Z (7 months ago)
• Last Synced: 2024-04-14T08:56:42.890Z (7 months ago)
• Topics: caa, dns, letsencrypt, module, nodejs, tls
• Language: JavaScript
• Homepage:
• Size: 434 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# caa

[![](https://img.shields.io/npm/v/caa.svg?style=flat)](https://www.npmjs.org/package/caa) [![](https://img.shields.io/npm/dm/caa.svg)](https://www.npmjs.org/package/caa) [![](https://packagephobia.com/badge?p=caa)](https://packagephobia.com/result?p=caa)

> [rfc6844](https://tools.ietf.org/html/rfc6844)-conform CAA record lookup and validation

## Usage

```js

import {caa, caaMatches} from "caa";

await caa("example.com");

// => [{flags: 0, tag: 'issue', value: 'letsencrypt.org', issuerCritical: false}]

await caaMatches("example.com", "letsencrypt.org");

// => true

```

## API

### `caa(name, [options])`

Retrieve the CAA records which apply to `name`. Returns a [`CAA` object](https://github.com/mafintosh/dns-packet/#caa).

### `caaMatches(name, ca, [options])`

Test if the CAA record for `name` matches for certificate authority `ca`.

#### `options`

- `servers`: The DNS servers to use. Defaults to the system resolvers or `['8.8.8.8', '8.8.4.4']` if none are configured.

- `port`: The port on the DNS server to use. Default `53`.

- `recursions`: How many recursions to follow. Default `50`.

- `retries`: How many retries to attempt. Default `12`.

- `ignoreTLDs`: Don't query top level domains like `com` in `example.com`. Default: `false`.

- `dnsSocket`: A [dns-socket instance](https://github.com/mafintosh/dns-socket#var-socket--dnsoptions), useful when doing a large amount of queries to re-use a single socket. Default: `undefined`.

## License

© [silverwind](https://github.com/silverwind), distributed under BSD licence