Browse Source

better package description

master
boB Rudis 1 year ago
parent
commit
965c76a235
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
5 changed files with 26 additions and 16 deletions
  1. +4
    -2
      DESCRIPTION
  2. +5
    -2
      R/clandnstine-package.R
  3. +2
    -2
      README.Rmd
  4. +11
    -8
      README.md
  5. +4
    -2
      man/clandnstine.Rd

+ 4
- 2
DESCRIPTION View File

@@ -8,8 +8,10 @@ Authors@R: c(
comment = c(ORCID = "0000-0001-5670-2640"))
)
Maintainer: Bob Rudis <bob@rud.is>
Description: Something something 'DNS. Something something 'TLS'.
Something something 'getdns API/library'.
Description: Methods are provided to query 'Domain Name System' ('DNS') stub
and recursive resolvers for all 'DNS' resource record types using 'UDP',
'TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
by the 'getdns' (<getdnsapi.net>) C library.
SystemRequirements: C++11; libgetdns v1.5.1 or higher
URL: https://gitlab.com/hrbrmstr/clandnstine
BugReports: https://gitlab.com/hrbrmstr/clandnstine/issues


+ 5
- 2
R/clandnstine-package.R View File

@@ -1,7 +1,10 @@
#' Perform Secure-by-default 'DNS' Queries
#'
#' Something something 'DNS. Something something 'TLS'.
#' Something something 'getdns API/library'.
#' Methods are provided to query 'Domain Name System' ('DNS') stub
#' and recursive resolvers for all 'DNS' resource record types using 'UDP',
#' TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
#' by the 'getdns' (<getdnsapi.net>) C library.
#'
#'
#' - URL: <https://gitlab.com/hrbrmstr/clandnstine>
#' - BugReports: <https://gitlab.com/hrbrmstr/clandnstine/issues>


+ 2
- 2
README.Rmd View File

@@ -18,7 +18,7 @@ Perform Secure-by-default 'DNS' Queries

## Description

Something something 'DNS. Something something 'TLS'. Something something 'getdns API/library'.
Methods are provided to query 'Domain Name System' ('DNS') stub and recursive resolvers for all 'DNS' resource record types using 'UDP', 'TCP', and/or 'TLS' transport layers. 'DNS' query support is provided by the 'getdns' (<getdnsapi.net>) C library.

## NOTE

@@ -35,7 +35,7 @@ I've gotten this running on macOS and Ubuntu 16.04. For the latter I had to ensu

## TODO/WAT

I finally grok the getdns api so the package api is going to change wildly and fast. The default mode will be to perform queries using DNS over TLS but also supports UDP and TCP transports.
I finally grok the getdns api so the package api is going to change wildly and fast. The default mode will be to perform queries using DNS over TLS but support is also provided for UDP and TCP transports and either stub or recursive resolvers.

## Why?



+ 11
- 8
README.md View File

@@ -11,8 +11,10 @@ Perform Secure-by-default ‘DNS’ Queries

## Description

Something something ‘DNS. Something something ’TLS’. Something something
‘getdns API/library’.
Methods are provided to query ‘Domain Name System’ (‘DNS’) stub and
recursive resolvers for all ‘DNS’ resource record types using ‘UDP’,
‘TCP’, and/or ‘TLS’ transport layers. ‘DNS’ query support is provided
by the ‘getdns’ (\<getdnsapi.net\>) C library.

## NOTE

@@ -37,7 +39,8 @@ extract it and `config`/`make`/`make install` (plus `ldconfig` after).

I finally grok the getdns api so the package api is going to change
wildly and fast. The default mode will be to perform queries using DNS
over TLS but also supports UDP and TCP transports.
over TLS but support is also provided for UDP and TCP transports and
either stub or recursive resolvers.

## Why?

@@ -189,9 +192,9 @@ gdns_lib_version()
## [1] "2604:a880:800:10::6bc:2001" "104.236.112.222"

(gdns_get_address(x, "yahoo.com"))
## [1] "2001:4998:58:1836::10" "2001:4998:58:1836::11" "2001:4998:c:1023::4" "2001:4998:c:1023::5"
## [5] "2001:4998:44:41d::3" "2001:4998:44:41d::4" "72.30.35.9" "72.30.35.10"
## [9] "98.137.246.7" "98.137.246.8" "98.138.219.231" "98.138.219.232"
## [1] "2001:4998:44:41d::4" "2001:4998:58:1836::10" "2001:4998:58:1836::11" "2001:4998:c:1023::4"
## [5] "2001:4998:c:1023::5" "2001:4998:44:41d::3" "98.137.246.8" "98.138.219.231"
## [9] "98.138.219.232" "72.30.35.9" "72.30.35.10" "98.137.246.7"

(gdns_get_address(x, "yahoo.commmm"))
## character(0)
@@ -204,7 +207,7 @@ str(leno <- gdns_query(x, "lenovo.com", "txt"), 1)
## List of 5
## $ answer_type : int 800
## $ canonical_name: chr "lenovo.com."
## $ replies_full : int [1, 1:600] 165 144 129 128 0 1 0 8 0 0 ...
## $ replies_full : int [1, 1:600] 192 224 129 128 0 1 0 8 0 0 ...
## $ replies_tree :'data.frame': 1 obs. of 7 variables:
## $ status : int 900
## - attr(*, "class")= chr [1:2] "gdns_response" "list"
@@ -228,7 +231,7 @@ Yep. Advertising even in DNS `TXT` records (see item number
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) |
| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: |
| C++ | 3 | 0.21 | 608 | 0.65 | 196 | 0.62 | 138 | 0.27 |
| R | 10 | 0.71 | 306 | 0.33 | 68 | 0.22 | 280 | 0.54 |
| R | 10 | 0.71 | 306 | 0.33 | 68 | 0.22 | 283 | 0.55 |
| Rmd | 1 | 0.07 | 19 | 0.02 | 51 | 0.16 | 97 | 0.19 |

## Code of Conduct


+ 4
- 2
man/clandnstine.Rd View File

@@ -6,8 +6,10 @@
\alias{clandnstine-package}
\title{Perform Secure-by-default 'DNS' Queries}
\description{
Something something 'DNS. Something something 'TLS'.
Something something 'getdns API/library'.
Methods are provided to query 'Domain Name System' ('DNS') stub
and recursive resolvers for all 'DNS' resource record types using 'UDP',
TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
by the 'getdns' (<getdnsapi.net>) C library.
}
\details{
\itemize{


Loading…
Cancel
Save