Motivation: There are various known issues in netty-codec-dns: - Message types are not interfaces, which can make it difficult for a user to implement his/her own message implementation. - Some class names and field names do not match with the terms in the RFC. - The support for decoding a DNS record was limited. A user had to encode and decode by him/herself. - The separation of DnsHeader from DnsMessage was unnecessary, although it is fine conceptually. - Buffer leak caused by DnsMessage was difficult to analyze, because the leak detector tracks down the underlying ByteBuf rather than the DnsMessage itself. - DnsMessage assumes DNS-over-UDP. - To send an EDNS message, a user have to create a new DNS record class instance unnecessarily. Modifications: - Make all message types interfaces and add default implementations - Rename some classes, properties, and constants to match the RFCs - DnsResource -> DnsRecord - DnsType -> DnsRecordType - and many more - Remove DnsClass and use an integer to support EDNS better - Add DnsRecordEncoder/DnsRecordDecoder and their default implementations - DnsRecord does not require RDATA to be ByteBuf anymore. - Add DnsRawRecord as the catch-all record type - Merge DnsHeader into DnsMessage - Make ResourceLeakDetector track AbstractDnsMessage - Remove DnsMessage.sender/recipient properties - Wrap DnsMessage with AddressedEnvelope - Add DatagramDnsQuest and DatagramDnsResponse for ease of use - Rename DnsQueryEncoder to DatagramDnsQueryEncoder - Rename DnsResponseDecoder to DatagramDnsResponseDecoder - Miscellaneous changes - Add StringUtil.TAB Result: - Cleaner APi - Can support DNS-over-TCP more easily in the future - Reduced memory footprint in the default DnsQuery/Response implementations - Better leak tracking for DnsMessages - Possibility to introduce new DnsRecord types in the future and provide full record encoder/decoder implementation. - No unnecessary instantiation for an EDNS pseudo resource record
225 lines
6.7 KiB
Java
225 lines
6.7 KiB
Java
/*
|
|
* Copyright 2015 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.handler.codec.dns;
|
|
|
|
import io.netty.channel.AddressedEnvelope;
|
|
|
|
import java.net.InetSocketAddress;
|
|
import java.net.SocketAddress;
|
|
|
|
/**
|
|
* A {@link DnsResponse} implementation for UDP/IP.
|
|
*/
|
|
public class DatagramDnsResponse extends DefaultDnsResponse
|
|
implements AddressedEnvelope<DatagramDnsResponse, InetSocketAddress> {
|
|
|
|
private final InetSocketAddress sender;
|
|
private final InetSocketAddress recipient;
|
|
|
|
/**
|
|
* Creates a new instance with the {@link DnsOpCode#QUERY} {@code opCode} and
|
|
* the {@link DnsResponseCode#NOERROR} {@code RCODE}.
|
|
*
|
|
* @param sender the address of the sender
|
|
* @param recipient the address of the recipient
|
|
* @param id the {@code ID} of the DNS response
|
|
*/
|
|
public DatagramDnsResponse(InetSocketAddress sender, InetSocketAddress recipient, int id) {
|
|
this(sender, recipient, id, DnsOpCode.QUERY, DnsResponseCode.NOERROR);
|
|
}
|
|
|
|
/**
|
|
* Creates a new instance with the {@link DnsResponseCode#NOERROR} responseCode.
|
|
*
|
|
* @param sender the address of the sender
|
|
* @param recipient the address of the recipient
|
|
* @param id the {@code ID} of the DNS response
|
|
* @param opCode the {@code opCode} of the DNS response
|
|
*/
|
|
public DatagramDnsResponse(InetSocketAddress sender, InetSocketAddress recipient, int id, DnsOpCode opCode) {
|
|
this(sender, recipient, id, opCode, DnsResponseCode.NOERROR);
|
|
}
|
|
|
|
/**
|
|
* Creates a new instance.
|
|
*
|
|
* @param sender the address of the sender
|
|
* @param recipient the address of the recipient
|
|
* @param id the {@code ID} of the DNS response
|
|
* @param opCode the {@code opCode} of the DNS response
|
|
* @param responseCode the {@code RCODE} of the DNS response
|
|
*/
|
|
public DatagramDnsResponse(
|
|
InetSocketAddress sender, InetSocketAddress recipient,
|
|
int id, DnsOpCode opCode, DnsResponseCode responseCode) {
|
|
super(id, opCode, responseCode);
|
|
|
|
if (recipient == null && sender == null) {
|
|
throw new NullPointerException("recipient and sender");
|
|
}
|
|
|
|
this.sender = sender;
|
|
this.recipient = recipient;
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse content() {
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
public InetSocketAddress sender() {
|
|
return sender;
|
|
}
|
|
|
|
@Override
|
|
public InetSocketAddress recipient() {
|
|
return recipient;
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setAuthoritativeAnswer(boolean authoritativeAnswer) {
|
|
return (DatagramDnsResponse) super.setAuthoritativeAnswer(authoritativeAnswer);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setTruncated(boolean truncated) {
|
|
return (DatagramDnsResponse) super.setTruncated(truncated);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setRecursionAvailable(boolean recursionAvailable) {
|
|
return (DatagramDnsResponse) super.setRecursionAvailable(recursionAvailable);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setCode(DnsResponseCode code) {
|
|
return (DatagramDnsResponse) super.setCode(code);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setId(int id) {
|
|
return (DatagramDnsResponse) super.setId(id);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setOpCode(DnsOpCode opCode) {
|
|
return (DatagramDnsResponse) super.setOpCode(opCode);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setRecursionDesired(boolean recursionDesired) {
|
|
return (DatagramDnsResponse) super.setRecursionDesired(recursionDesired);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setZ(int z) {
|
|
return (DatagramDnsResponse) super.setZ(z);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse setRecord(DnsSection section, DnsRecord record) {
|
|
return (DatagramDnsResponse) super.setRecord(section, record);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse addRecord(DnsSection section, DnsRecord record) {
|
|
return (DatagramDnsResponse) super.addRecord(section, record);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse addRecord(DnsSection section, int index, DnsRecord record) {
|
|
return (DatagramDnsResponse) super.addRecord(section, index, record);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse clear(DnsSection section) {
|
|
return (DatagramDnsResponse) super.clear(section);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse clear() {
|
|
return (DatagramDnsResponse) super.clear();
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse touch() {
|
|
return (DatagramDnsResponse) super.touch();
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse touch(Object hint) {
|
|
return (DatagramDnsResponse) super.touch(hint);
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse retain() {
|
|
return (DatagramDnsResponse) super.retain();
|
|
}
|
|
|
|
@Override
|
|
public DatagramDnsResponse retain(int increment) {
|
|
return (DatagramDnsResponse) super.retain(increment);
|
|
}
|
|
|
|
@Override
|
|
public boolean equals(Object obj) {
|
|
if (this == obj) {
|
|
return true;
|
|
}
|
|
|
|
if (!super.equals(obj)) {
|
|
return false;
|
|
}
|
|
|
|
if (!(obj instanceof AddressedEnvelope)) {
|
|
return false;
|
|
}
|
|
|
|
@SuppressWarnings("unchecked")
|
|
final AddressedEnvelope<?, SocketAddress> that = (AddressedEnvelope<?, SocketAddress>) obj;
|
|
if (sender() == null) {
|
|
if (that.sender() != null) {
|
|
return false;
|
|
}
|
|
} else if (!sender().equals(that.sender())) {
|
|
return false;
|
|
}
|
|
|
|
if (recipient() == null) {
|
|
if (that.recipient() != null) {
|
|
return false;
|
|
}
|
|
} else if (!recipient().equals(that.recipient())) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
@Override
|
|
public int hashCode() {
|
|
int hashCode = super.hashCode();
|
|
if (sender() != null) {
|
|
hashCode = hashCode * 31 + sender().hashCode();
|
|
}
|
|
if (recipient() != null) {
|
|
hashCode = hashCode * 31 + recipient().hashCode();
|
|
}
|
|
return hashCode;
|
|
}
|
|
}
|