nsupdate.html revision f46b1b2329c4e56af6b231470e00053bad25e9e2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!--
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater - Copyright (C) 2000, 2001 Internet Software Consortium.
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and distribute this software for any
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein-->
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater<HTML
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><HEAD
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><TITLE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</TITLE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><META
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark AndrewsNAME="GENERATOR"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCONTENT="Modular DocBook HTML Stylesheet Version 1.61
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein"></HEAD
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><BODY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinBGCOLOR="#FFFFFF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinTEXT="#000000"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinLINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinVLINK="#840084"
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsALINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><H1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN1"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></H1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFNAMEDIV"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN8"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>Name</H2
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>nsupdate&nbsp;--&nbsp;Dynamic DNS update utility</DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSYNOPSISDIV"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN11"
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater></A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><H2
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater>Synopsis</H2
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater><P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-d</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>] [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updater>-y <TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REPLACEABLE"
68b30890ebd441a6a1ae3fdf71744d07d02cd030Mark Andrews><I
68b30890ebd441a6a1ae3fdf71744d07d02cd030Mark Andrews>keyname:secret</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> | <TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-k <TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REPLACEABLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>keyfile</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>] [<TT
b05bdb520d83f7ecaad708fe305268c3420be01dMark AndrewsCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-v</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>] [filename]</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSECT1"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
ac93437301f55ed69bf85883a497a75598c628f9Automatic UpdaterNAME="AEN26"
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updater></A
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updater><H2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>DESCRIPTION</H2
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updater><P
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updater><B
ac93437301f55ed69bf85883a497a75598c628f9Automatic UpdaterCLASS="COMMAND"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>nsupdate</B
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews>
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updateris used to submit Dynamic DNS Update requests as defined in RFC2136
ac93437301f55ed69bf85883a497a75598c628f9Automatic Updaterto a name server.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsThis allows resource records to be added or removed from a zone
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Lucewithout manually editing the zone file.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric LuceA single update request can contain requests to add or remove more than one
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luceresource record.</P
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce><P
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce>Zones that are under dynamic control via
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce<B
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric LuceCLASS="COMMAND"
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce>nsupdate</B
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce>
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrewsor a DHCP server should not be edited by hand.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric LuceManual edits could
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luceconflict with dynamic updates and cause data to be lost.</P
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce><P
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce>The resource records that are dynamically added or removed with
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinhave to be in the same zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinRequests are sent to the zone's master server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThis is identified by the MNAME field of the zone's SOA record.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><P
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>The
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsCLASS="OPTION"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>-d</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinoption makes
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater>nsupdate</B
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinoperate in debug mode.
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic UpdaterThis provides tracing information about the update requests that are
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updatermade and the replies received from the name server.</P
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updater><P
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updater>Transaction signatures can be used to authenticate the Dynamic DNS
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic Updaterupdates.
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic UpdaterThese use the TSIG resource record type described in RFC2845.
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic UpdaterThe signatures rely on a shared secret that should only be known to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinand the name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCurrently, the only supported encryption algorithm for TSIG is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinHMAC-MD5, which is defined in RFC 2104.
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsOnce other algorithms are defined for TSIG, applications will need to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinensure they select the appropriate algorithm as well as the key when
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinauthenticating each other.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFor instance suitable
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<SPAN
9c6a5d1f22f972232d7a9fd5c5fa64f10bacbdffAutomatic UpdaterCLASS="TYPE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>key</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinand
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic Updater<SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="TYPE"
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews>server</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstatements would be added to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>/etc/named.conf</TT
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinso that the name server can associate the appropriate secret key
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinand algorithm with the IP address of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinclient application that will be using TSIG authentication.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeindoes not read
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>/etc/named.conf</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><P
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews><B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinuses the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
dcfda24abf565c442d058cbf81b2180d847a1b3eAutomatic UpdaterCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-y</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinor
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-k</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinoption to provide the shared secret needed to generate a TSIG record
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrewsfor authenticating Dynamic DNS update requests.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsThese options are mutually exclusive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinWith the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsCLASS="OPTION"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>-k</TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrewsoption,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinreads the shared secret from the file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>keyfile</I
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinwhose name is of the form
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>K{name}.+157.+{random}.private</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFor historical
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinreasons, the file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>K{name}.+157.+{random}.key</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinmust also be present. When the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-y</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinoption is used, a signature is generated from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>keyname:secret.</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>keyname</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinis the name of the key,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinand
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>secret</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinis the base64 encoded shared secret.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinUse of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-y</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinoption is discouraged because the shared secret is supplied as a command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinline argument in clear text.
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsThis may be visible in the output from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>ps</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>(1)</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
or in a history file maintained by the user's shell.</P
><P
>By default
<B
CLASS="COMMAND"
>nsupdate</B
>
uses UDP to send update requests to the name server.
The
<TT
CLASS="OPTION"
>-v</TT
>
option makes
<B
CLASS="COMMAND"
>nsupdate</B
>
use a TCP connection.
This may be preferable when a batch of update requests is made.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN65"
></A
><H2
>INPUT FORMAT</H2
><P
><B
CLASS="COMMAND"
>nsupdate</B
>
reads input from
<TT
CLASS="PARAMETER"
><I
>filename</I
></TT
>
or standard input.
Each command is supplied on exactly one line of input.
Some commands are for administrative purposes.
The others are either update instructions or prerequisite checks on the
contents of the zone.
These checks set conditions that some name or set of
resource records (RRset) either exists or is absent from the zone.
These conditions must be met if the entire update request is to succeed.
Updates will be rejected if the tests for the prerequisite conditions fail.</P
><P
>Every update request consists of zero or more prerequisites
and zero or more updates.
This allows a suitably authenticated update request to proceed if some
specified resource records are present or missing from the zone.
A blank input line (or the <B
CLASS="COMMAND"
>send</B
> command) causes the
accumulated commands to be sent as one Dynamic DNS update request to the
name server.</P
><P
>The command formats and their meaning are as follows:
<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><P
><B
CLASS="COMMAND"
>server</B
> {servername} [port]</P
></DT
><DD
><P
>Sends all dynamic update requests to the name server
<TT
CLASS="PARAMETER"
><I
>servername</I
></TT
>.
When no server statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
will send updates to the master server of the correct zone.
The MNAME field of that zone's SOA record will identify the master
server for that zone.
<TT
CLASS="PARAMETER"
><I
>port</I
></TT
>
is the port number on
<TT
CLASS="PARAMETER"
><I
>servername</I
></TT
>
where the dynamic update requests get sent.
If no port number is specified, the default DNS port number of 53 is
used.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>local</B
> {address} [port]</P
></DT
><DD
><P
>Sends all dynamic update requests using the local
<TT
CLASS="PARAMETER"
><I
>address</I
></TT
>.
When no local statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
will send updates using an address and port choosen by the system.
<TT
CLASS="PARAMETER"
><I
>port</I
></TT
>
can additionally be used to make requests come from a specific port.
If no port number is specified, the system will assign one.&#13;</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>zone</B
> {zonename}</P
></DT
><DD
><P
>Specifies that all updates are to be made to the zone
<TT
CLASS="PARAMETER"
><I
>zonename</I
></TT
>.
If no
<TT
CLASS="PARAMETER"
><I
>zone</I
></TT
>
statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
will attempt determine the correct zone to update based on the rest of the input.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>key</B
> {name} {secret}</P
></DT
><DD
><P
>Specifies that all updates are to be TSIG signed using the
<TT
CLASS="PARAMETER"
><I
>keyname</I
></TT
> <TT
CLASS="PARAMETER"
><I
>keysecret</I
></TT
> pair.
The <B
CLASS="COMMAND"
>key</B
> command
overrides any key specified on the command line via
<TT
CLASS="OPTION"
>-y</TT
> or <TT
CLASS="OPTION"
>-k</TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq nxdomain</B
> {domain-name}</P
></DT
><DD
><P
>Requires that no resource record of any type exists with name
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxdomain</B
> {domain-name}</P
></DT
><DD
><P
>Requires that
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
exists (has as at least one resource record, of any type).</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq nxrrset</B
> {domain-name} [class] {type}</P
></DT
><DD
><P
>Requires that no resource record exists of the specified
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
If
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is omitted, IN (internet) is assumed.
&#13;</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxrrset</B
> {domain-name} [class] {type}</P
></DT
><DD
><P
>This requires that a resource record of the specified
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
must exist.
If
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is omitted, IN (internet) is assumed.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxrrset</B
> {domain-name} [class] {type} {data...}</P
></DT
><DD
><P
>The
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
from each set of prerequisites of this form
sharing a common
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>,
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
are combined to form a set of RRs. This set of RRs must
exactly match the set of RRs existing in the zone at the
given
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>,
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
The
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
are written in the standard text representation of the resource record's
RDATA.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>update delete</B
> {domain-name} [ttl] [class] [type [data...]]</P
></DT
><DD
><P
>Deletes any resource records named
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
If
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
is provided, only matching resource records will be removed.
The internet class is assumed if
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is not supplied. The
<TT
CLASS="PARAMETER"
><I
>ttl</I
></TT
>
is ignored, and is only allowed for compatibility.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>update add</B
> {domain-name} {ttl} [class] {type} {data...}</P
></DT
><DD
><P
>Adds a new resource record with the specified
<TT
CLASS="PARAMETER"
><I
>ttl</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>show</B
> </P
></DT
><DD
><P
>Displays the current message, containing all of the prerequisites and
updates specified since the last send.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>send</B
> </P
></DT
><DD
><P
>Sends the current message. This is equivalent to entering a blank line.</P
></DD
></DL
></DIV
>&#13;</P
><P
>Lines beginning with a semicolon are comments, and are ignored.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN223"
></A
><H2
>EXAMPLES</H2
><P
>The examples below show how
<B
CLASS="COMMAND"
>nsupdate</B
>
could be used to insert and delete resource records from the
<SPAN
CLASS="TYPE"
>example.com</SPAN
>
zone.
Notice that the input in each example contains a trailing blank line so that
a group of commands are sent as one dynamic update request to the
master name server for
<SPAN
CLASS="TYPE"
>example.com</SPAN
>.
<PRE
CLASS="PROGRAMLISTING"
># nsupdate
&#62; update delete oldhost.example.com A
&#62; update add newhost.example.com 86400 A 172.16.1.1
&#62;</PRE
></P
><P
>Any A records for
<SPAN
CLASS="TYPE"
>oldhost.example.com</SPAN
>
are deleted.
and an A record for
<SPAN
CLASS="TYPE"
>newhost.example.com</SPAN
>
it IP address 172.16.1.1 is added.
The newly-added record has a 1 day TTL (86400 seconds)
<PRE
CLASS="PROGRAMLISTING"
># nsupdate
&#62; prereq nxdomain nickname.example.com
&#62; update add nickname.example.com CNAME somehost.example.com
&#62;</PRE
></P
><P
>The prerequisite condition gets the name server to check that there
are no resource records of any type for
<SPAN
CLASS="TYPE"
>nickname.example.com</SPAN
>.
If there are, the update request fails.
If this name does not exist, a CNAME for it is added.
This ensures that when the CNAME is added, it cannot conflict with the
long-standing rule in RFC1034 that a name must not exist as any other
record type if it exists as a CNAME.
(The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
SIG, KEY and NXT records.)</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN236"
></A
><H2
>FILES</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="CONSTANT"
>/etc/resolv.conf</TT
></DT
><DD
><P
>used to identify default name server</P
></DD
><DT
><TT
CLASS="CONSTANT"
>K{name}.+157.+{random}.key</TT
></DT
><DD
><P
>base-64 encoding of HMAC-MD5 key created by
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>dnssec-keygen</SPAN
>(8)</SPAN
>.</P
></DD
><DT
><TT
CLASS="CONSTANT"
>K{name}.+157.+{random}.private</TT
></DT
><DD
><P
>base-64 encoding of HMAC-MD5 key created by
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>dnssec-keygen</SPAN
>(8)</SPAN
>.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN260"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2136</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC3007</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2104</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2845</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC1034</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2535</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>named</SPAN
>(8)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>dnssec-keygen</SPAN
>(8)</SPAN
>.&#13;</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN281"
></A
><H2
>BUGS</H2
><P
>The TSIG key is redundantly stored in two separate files.
This is a consequence of nsupdate using the DST library
for its cryptographic operations, and may change in future
releases.</P
></DIV
></BODY
></HTML
>