Package org.xbill.DNS

Class TKEYRecord

java.lang.Object

org.xbill.DNS.Record

org.xbill.DNS.TKEYRecord

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Record>

public class TKEYRecord
extends Record

Transaction Key - used to compute and/or securely transport a shared secret to be used with TSIG.

Author:

Brian Wellington

See Also:

• TSIG
• RFC 2930: Secret Key Establishment for DNS (TKEY RR)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DELETE	The key should be deleted
static final int	DIFFIEHELLMAN	The key is computed using a Diffie-Hellman key exchange
static final int	GSSAPI	The key is computed using GSS_API (unimplemented)
static final int	RESOLVERASSIGNED	The key is assigned by the resolver (unimplemented)
static final int	SERVERASSIGNED	The key is assigned by the server (unimplemented)

Fields inherited from class org.xbill.DNS.Record

dclass, name, ttl, type

Constructor Summary

Constructors

Constructor	Description
TKEYRecord(Name name, int dclass, long ttl, Name alg, Instant timeInception, Instant timeExpire, int mode, int error, byte[] key, byte[] other)	Creates a TKEY Record from the given data.
TKEYRecord(Name name, int dclass, long ttl, Name alg, Date timeInception, Date timeExpire, int mode, int error, byte[] key, byte[] other)	Deprecated. use TKEYRecord(Name, int, long, Name, Instant, Instant, int, int, byte[], byte[])

Method Summary

Modifier and Type	Method	Description
Name	getAlgorithm()	Returns the shared key's algorithm
int	getError()	Returns the extended error
byte[]	getKey()	Returns the shared secret or keying material
int	getMode()	Returns the key agreement mode
byte[]	getOther()	Returns the other data
Instant	getTimeExpire()	Returns the end of the validity period of the shared secret or keying material
Instant	getTimeInception()	Returns the beginning of the validity period of the shared secret or keying material
protected String	modeString()
protected void	rdataFromString(Tokenizer st, Name origin)	Converts the text format of an RR to the internal format - must be overriden
protected void	rrFromWire(DNSInput in)	Converts the type-specific RR to wire format - must be overridden
protected String	rrToString()	Converts rdata to a String
protected void	rrToWire(DNSOutput out, Compression c, boolean canonical)	Converts the type-specific RR to wire format - must be overridden.

Methods inherited from class org.xbill.DNS.Record

byteArrayFromString, byteArrayToString, compareTo, equals, fromString, fromString, fromWire, getAdditionalName, getDClass, getName, getRRsetType, getTTL, getType, hashCode, newRecord, newRecord, newRecord, newRecord, rdataToString, rdataToWireCanonical, sameRRset, sameRRset, toString, toWire, toWireCanonical, unknownToString, withName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERVERASSIGNED

public static final int SERVERASSIGNED

The key is assigned by the server (unimplemented)

See Also:

• Constant Field Values

DIFFIEHELLMAN

public static final int DIFFIEHELLMAN

The key is computed using a Diffie-Hellman key exchange

See Also:

• Constant Field Values

GSSAPI

public static final int GSSAPI

The key is computed using GSS_API (unimplemented)

See Also:

• Constant Field Values

RESOLVERASSIGNED

public static final int RESOLVERASSIGNED

The key is assigned by the resolver (unimplemented)

See Also:

• Constant Field Values

DELETE

public static final int DELETE

The key should be deleted

See Also:

• Constant Field Values

Constructor Details

TKEYRecord

public TKEYRecord(Name name,
 int dclass,
 long ttl,
 Name alg,
 Instant timeInception,
 Instant timeExpire,
 int mode,
 int error,
 byte[] key,
 byte[] other)

Creates a TKEY Record from the given data.

Parameters:

alg - The shared key's algorithm

timeInception - The beginning of the validity period of the shared secret or keying material

timeExpire - The end of the validity period of the shared secret or keying material

mode - The mode of key agreement

error - The extended error field. Should be 0 in queries

key - The shared secret

other - The other data field. Currently unused responses.

TKEYRecord

@Deprecated
public TKEYRecord(Name name,
 int dclass,
 long ttl,
 Name alg,
 Date timeInception,
 Date timeExpire,
 int mode,
 int error,
 byte[] key,
 byte[] other)

Deprecated.

use TKEYRecord(Name, int, long, Name, Instant, Instant, int, int, byte[], byte[])

Creates a TKEY Record from the given data.

Parameters:

alg - The shared key's algorithm

timeInception - The beginning of the validity period of the shared secret or keying material

timeExpire - The end of the validity period of the shared secret or keying material

mode - The mode of key agreement

error - The extended error field. Should be 0 in queries

key - The shared secret

other - The other data field. Currently unused responses.

Method Details

rrFromWire

protected void rrFromWire(DNSInput in)
                   throws IOException

Description copied from class: Record

Converts the type-specific RR to wire format - must be overridden

Specified by:

rrFromWire in class Record

Throws:

IOException

rdataFromString

protected void rdataFromString(Tokenizer st,
 Name origin)
                        throws IOException

Description copied from class: Record

Converts the text format of an RR to the internal format - must be overriden

Specified by:

rdataFromString in class Record

Throws:

IOException

modeString

protected String modeString()

rrToString

protected String rrToString()

Converts rdata to a String

Specified by:

rrToString in class Record

getAlgorithm

public Name getAlgorithm()

Returns the shared key's algorithm

getTimeInception

public Instant getTimeInception()

Returns the beginning of the validity period of the shared secret or keying material

getTimeExpire

public Instant getTimeExpire()

Returns the end of the validity period of the shared secret or keying material

getMode

public int getMode()

Returns the key agreement mode

getError

public int getError()

Returns the extended error

getKey

public byte[] getKey()

Returns the shared secret or keying material

getOther

public byte[] getOther()

Returns the other data

rrToWire

protected void rrToWire(DNSOutput out,
 Compression c,
 boolean canonical)

Description copied from class: Record

Converts the type-specific RR to wire format - must be overridden.

Specified by:

rrToWire in class Record