Skip to content

Commit 7854258

Browse files
adam-burnsadam-burns
committed
adds workflow scripts
1 parent 044e2b3 commit 7854258

2 files changed

Lines changed: 194 additions & 1 deletion

File tree

‎hugo-gh/content/tutorials/Command-Line-tool.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
22
title = 'sig0namectl Command Line Usage'
3-
date = 2024-06-29T14:17:22+02:00
3+
date = 2024-05-29T14:17:22+02:00
44
draft = false
55
summary = 'Usage examples of the sig0namectl tool to query and update DNS resource records.'
66
+++

‎hugo-gh/content/tutorials/Workflow-Automation-Scripts.md‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
+++
2+
title = 'sig0namectl Workflow Automation'
3+
date = 2024-07-01T14:17:22+02:00
4+
draft = false
5+
summary = 'Usage examples of sig0namectl workflow scripts tool to assist with automation and deployment on resource constrained devices.'
6+
+++
7+
8+
This section documents and gives usage examples for sig0namectl bash shell scripts.
9+
10+
```
11+
NAME:
12+
request_key - create and submit a new SIG(0) key for a domain name
13+
14+
USAGE:
15+
request_key [options] new_domain
16+
17+
WHERE:
18+
new_domain is the requested fully qualified domain name
19+
20+
OPTIONS:
21+
-d set update action to delete (default update action is add)
22+
-s set keystore path (NSUPDATE_SIG0_PATH)
23+
-k set explicit key to sign request (default is the script autodetects correct key)
24+
25+
ENVIRONMENT VARIABLES:
26+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
27+
NEW_FQDN specifies the fully qualified domain name to update
28+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
29+
```
30+
31+
```
32+
NAME:
33+
dyn_ip - manage IPv4 and IPv6 address records for domain names at or below names of existing keys in keystore
34+
35+
USAGE:
36+
dyn_ip [options] domain ip_address ...
37+
38+
WHERE:
39+
domain is a fully qualified domain name at or below the name of a key in the keystore
40+
ip_addresses is any number of IPv4 or IPv6 addresses
41+
42+
OPTIONS:
43+
-d set update action to delete (default update action is add)
44+
-s set keystore path (NSUPDATE_SIG0_PATH)
45+
-k set explicit key to sign request (default is the script autodetects correct key)
46+
47+
ENVIRONMENT VARIABLES:
48+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
49+
NEW_FQDN specifies the fully qualified domain name to update
50+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
51+
```
52+
```
53+
NAME:
54+
dyn_txt - manage text information records for domain names at or below names of existing keys in keystore
55+
56+
USAGE:
57+
dyn_txt [options] domain text_info ...
58+
59+
WHERE:
60+
domain is a fully qualified domain name at or below the name of a key in the keystore
61+
text_info is one or more text strings (encapsulate in double quotes for strings that contain spaces)
62+
63+
OPTIONS:
64+
-d set update action to delete (default update action is add)
65+
-s set keystore path (NSUPDATE_SIG0_PATH)
66+
-k set explicit key to sign request (default is the script autodetects correct key)
67+
68+
ENVIRONMENT VARIABLES:
69+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
70+
NEW_FQDN specifies the fully qualified domain name to update
71+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
72+
```
73+
74+
```
75+
NAME:
76+
dyn_loc - manage geolocation records for domain names at or below names of existing keys in keystore
77+
78+
USAGE:
79+
dyn_loc [options] domain
80+
81+
WHERE:
82+
domain is a fully qualified domain name at or below the name of a key in the keystore
83+
The geolocation information of latitute, longitude and altitude will be read from on-device GPS hardware.
84+
(currently compatible with Android phones running Termux and Linux computers running gpsd)
85+
86+
87+
OPTIONS:
88+
-d set update action to delete (default update action is add)
89+
-s set keystore path (NSUPDATE_SIG0_PATH)
90+
-k set explicit key to sign request (default is the script autodetects correct key)
91+
92+
ENVIRONMENT VARIABLES:
93+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
94+
NEW_FQDN specifies the fully qualified domain name to update
95+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
96+
```
97+
```
98+
NAME:
99+
dyn_key - manage key records for domain names at or below names of existing keys in keystore
100+
101+
USAGE:
102+
dyn_key [options] domain public_key_fqdn ...
103+
104+
WHERE:
105+
domain is a fully qualified domain name at or below the name of a key in the keystore
106+
public_key_fqdn is one or more fully qualifed domain names of existing key records to add to the domain
107+
(if no public_key_fqdn is specified, then all existing key records at 'domain' are listed)
108+
109+
OPTIONS:
110+
-d set update action to delete (default update action is add)
111+
-s set keystore path (NSUPDATE_SIG0_PATH)
112+
-k set explicit key to sign request (default is the script autodetects correct key)
113+
114+
ENVIRONMENT VARIABLES:
115+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
116+
NEW_FQDN specifies the fully qualified domain name to update
117+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
118+
```
119+
120+
```
121+
NAME:
122+
dnssd-domain - manage DNS Service Discovery domain pointer records for domain names at or below names of existing keys in keystore
123+
124+
125+
USAGE:
126+
dnssd-domain [options] domain
127+
128+
WHERE:
129+
domain is a fully qualified domain name at or below the name of a key in the keystore
130+
131+
132+
OPTIONS:
133+
-d set update action to delete (default update action is add)
134+
-s set keystore path (NSUPDATE_SIG0_PATH)
135+
-k set explicit key to sign request (default is the script autodetects correct key)
136+
137+
ENVIRONMENT VARIABLES:
138+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
139+
NEW_FQDN specifies the fully qualified domain name to update
140+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
141+
```
142+
143+
```
144+
NAME:
145+
dnssd-service - manage DNS Service Discovery service type records for domain names at or below names of existing keys in keystore
146+
147+
148+
USAGE:
149+
dnssd-service [options] domain
150+
151+
WHERE:
152+
domain is a fully qualified domain name at or below the name of a key in the keystore
153+
The environment variable DNSSD_SERVICES contains a list of service types to create for the DNSSD domain.
154+
155+
156+
OPTIONS:
157+
-d set update action to delete (default update action is add)
158+
-s set keystore path (NSUPDATE_SIG0_PATH)
159+
-k set explicit key to sign request (default is the script autodetects correct key)
160+
161+
ENVIRONMENT VARIABLES:
162+
DNSSD_SERVICES specifies the service types to add to the DNSSD domain (eg "_http._tcp _ssh._tcp" etc.)
163+
164+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
165+
NEW_FQDN specifies the fully qualified domain name to update
166+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
167+
```
168+
169+
```
170+
NAME:
171+
process_requests - manage sig0namectl key requests
172+
173+
174+
USAGE:
175+
process_requests [options] domain
176+
177+
WHERE:
178+
domain is a fully qualified domain name at or below the name of a key in the keystore
179+
180+
The process_requests tool is designed to be run by a DNS zone administrator and is designed to handle new key requests for names under a DNS zone.
181+
It is run remotely by the device that has an active key at the FQDN of the zone in its keystore.
182+
183+
OPTIONS:
184+
-d set update action to delete (default update action is add)
185+
-s set keystore path (NSUPDATE_SIG0_PATH)
186+
-k set explicit key to sign request (default is the script autodetects correct key)
187+
188+
ENVIRONMENT VARIABLES:
189+
NSUPDATE_SIG0_KEYPATH specifies the full directory path of the keystore to read and write SIG(0) keys
190+
ZONE the DNS zone of the fully qualified domain name (default is autodetect zone)
191+
```
192+
193+

0 commit comments

Comments
 (0)