Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plantain-00/dns-protocol

A Library to encode and parse data for DNS protocol.
https://github.com/plantain-00/dns-protocol

Last synced: 12 days ago
JSON representation

A Library to encode and parse data for DNS protocol.

Host: GitHub
URL: https://github.com/plantain-00/dns-protocol
Owner: plantain-00
License: mit
Created: 2017-09-20T22:58:09.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-12-02T23:25:50.000Z (almost 2 years ago)
Last Synced: 2024-04-13T19:24:56.329Z (7 months ago)
Language: TypeScript
Size: 1.42 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # dns-protocol

[![Dependency Status](https://david-dm.org/plantain-00/dns-protocol.svg)](https://david-dm.org/plantain-00/dns-protocol)

[![devDependency Status](https://david-dm.org/plantain-00/dns-protocol/dev-status.svg)](https://david-dm.org/plantain-00/dns-protocol#info=devDependencies)

[![Build Status: Windows](https://ci.appveyor.com/api/projects/status/github/plantain-00/dns-protocol?branch=master&svg=true)](https://ci.appveyor.com/project/plantain-00/dns-protocol/branch/master)

![Github CI](https://github.com/plantain-00/dns-protocol/workflows/Github%20CI/badge.svg)

[![npm version](https://badge.fury.io/js/dns-protocol.svg)](https://badge.fury.io/js/dns-protocol)

[![Downloads](https://img.shields.io/npm/dm/dns-protocol.svg)](https://www.npmjs.com/package/dns-protocol)

[![gzip size](https://img.badgesize.io/https://unpkg.com/dns-protocol?compression=gzip)](https://unpkg.com/dns-protocol)

[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Fdns-protocol%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/dns-protocol)

A Library to encode and parse data for DNS protocol.

## install

`yarn global add dns-protocol`

## usage

```ts

import Message, { MessageType } from "dns-protocol";

// 

// construct request

const request = new Message(43825);

request.addQuestion("www.example.com");

// encode request

const encodedRequest = request.encode(); // [0xab, 0x31, 0x01, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x77, 0x77, 0x77, 0x07, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x03, 0x63, 0x6f, 0x6d, 0x00, 0x00, 0x01, 0x00, 0x01]

// parse encoded request

const decodedRequest = Message.parse(encodedRequest.buffer);

// construct response

decodedRequest.type = MessageType.response;

decodedRequest.recursionAvailable = true;

decodedRequest.addAddress("www.example.com", 20680, "93.184.216.34");

// encode response

const encodedAnswer = decodedRequest.encode(); // [0xab, 0x31, 0x81, 0x80, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x03, 0x77, 0x77, 0x77, 0x07, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x03, 0x63, 0x6f, 0x6d, 0x00, 0x00, 0x01, 0x00, 0x01, 0xc0, 0x0c, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x50, 0xc8, 0x00, 0x04, 0x5d, 0xb8, 0xd8, 0x22]

// parse encoded response

const decodedAnswer = Message.parse(encodedAnswer.buffer as ArrayBuffer);

```

## change logs

```ts

// v2

import Message, { MessageType } from "dns-protocol/nodejs";

import Message, { MessageType } from "dns-protocol/browser";

// v1

import Message, { MessageType } from "dns-protocol/nodejs/nodejs";

import Message, { MessageType } from "dns-protocol/browser/browser";

```