zishuo/nip
1
0
Fork 0
mirror of https://github.com/cunnie/sslip.io.git synced 2025-10-06 16:18:00 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Use dnsmessage's Parser() and Builder()`

Browse Source 
- Change Ginkgo's `To(Not(` to use the shorter `ToNot(`
- did fewer initializations in the `vars` block and moved them to the
  `BeforeEach()` blocks.

The `QueryResponse()` test is too long & convoluted; even I have a hard
time understanding them, and I wrote them! The tests & code should be
re-written, but that's for another day.
This commit is contained in:
Brian Cunnie
2020-09-20 16:39:04 -07:00
parent 67acbb7f47
commit c4e5dfb0ca
2 changed files with 141 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/xip/xip.go
View File

@@ -25,14 +25,17 @@ func QueryResponse(queryBytes []byte) ([]byte, error) {
var queryHeader dnsmessage.Header
var err error
var response []byte
var p dnsmessage.Parser
p := dnsmessage.Parser{}
if queryHeader, err = p.Start(queryBytes); err != nil {
return nil, err
}
b := dnsmessage.NewBuilder(response, ResponseHeader(queryHeader))
b.EnableCompression()
if err = b.StartQuestions(); err != nil {
return nil, err
}
for {
q, err := p.Question()
if err == dnsmessage.ErrSectionDone {
@@ -41,6 +44,9 @@ func QueryResponse(queryBytes []byte) ([]byte, error) {
if err != nil {
return nil, err
}
if err = b.Question(q); err != nil {
return nil, err
}
switch q.Type {
case dnsmessage.TypeA:
{
@@ -73,7 +79,7 @@ func QueryResponse(queryBytes []byte) ([]byte, error) {
Name: q.Name,
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
TTL: 604800, // 60 * 60 * 24 * 7 == 1 week; it's not gonna change
TTL: 604800, // 60 * 60 * 24 * 7 == 1 week; long TTL, these IP addrs don't change
Length: 0,
}, *nameToA)
if err != nil {
@@ -86,7 +92,7 @@ func QueryResponse(queryBytes []byte) ([]byte, error) {
}
responseBytes, err := b.Finish()
// I couldn't figure an easy way to test the error condition in Ginkgo. Sue me.
// I couldn't figure an easy way to test the error condition in Ginkgo
if err != nil {
return nil, err
}
@@ -137,7 +143,7 @@ func NameToAAAA(fqdnString string) (*dnsmessage.AAAAResource, error) {
ipv16address := net.ParseIP(match).To16()
AAAAR := dnsmessage.AAAAResource{}
for i, _ := range ipv16address {
for i := range ipv16address {
AAAAR.AAAA[i] = ipv16address[i]
}
return &AAAAR, nil
@@ -165,4 +171,4 @@ func SOAResource(domain string) dnsmessage.SOAResource {
Expire: 1800,
MinTTL: 300,
}
}
}

202
src/xip/xip_test.go
View File

@@ -12,79 +12,99 @@ import (
var _ = Describe("Xip", func() {
var (
err error
name = "127.0.0.1.sslip.io."
nameArray [255]byte
packedQuery []byte
packedResponse []byte
response dnsmessage.Message
headerId uint16
query = dnsmessage.Message{
Header: dnsmessage.Header{
ID: headerId,
RecursionDesired: true,
},
Questions: []dnsmessage.Question{
{
Name: dnsmessage.Name{Length: uint8(len(name)), Data: nameArray},
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
},
},
Answers: nil,
Authorities: nil,
Additionals: nil,
}
expectedResponse = dnsmessage.Message{
Header: dnsmessage.Header{
ID: headerId,
Response: true,
OpCode: 0,
Authoritative: true,
Truncated: false,
RecursionDesired: true,
RecursionAvailable: false,
},
Answers: []dnsmessage.Resource{
{
Header: dnsmessage.ResourceHeader{
Name: query.Questions[0].Name,
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
TTL: 300,
Length: 4,
},
Body: &dnsmessage.AResource{A: [4]byte{127, 0, 0, 1}},
},
},
Authorities: []dnsmessage.Resource{},
// {
// Header: dnsmessage.ResourceHeader{},
// Body: xip.SOAResource(name),
// },
//},
Additionals: []dnsmessage.Resource{},
}
err error
queryBuilder dnsmessage.Builder
name string
nameArray [255]byte
packedQuery []byte
packedResponse []byte
response dnsmessage.Message
expectedResponse dnsmessage.Message
headerId uint16
question dnsmessage.Question
)
Describe("QueryResponse()", func() {
BeforeEach(func() {
name = "127.0.0.1.sslip.io."
copy(nameArray[:], name)
// Set the query's header ID
headerId = uint16(rand.Int31())
question = dnsmessage.Question{
Name: dnsmessage.Name{Length: uint8(len(name)), Data: nameArray},
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
}
expectedResponse = dnsmessage.Message{
Header: dnsmessage.Header{
ID: headerId,
Response: true,
OpCode: 0,
Authoritative: true,
Truncated: false,
RecursionDesired: true,
RecursionAvailable: false,
},
Answers: []dnsmessage.Resource{
{
Header: dnsmessage.ResourceHeader{
Name: question.Name,
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
TTL: 604800,
Length: 4,
},
Body: &dnsmessage.AResource{A: [4]byte{127, 0, 0, 1}},
},
},
Authorities: []dnsmessage.Resource{},
Additionals: []dnsmessage.Resource{},
}
})
JustBeforeEach(func() {
// Warning: this JustBeforeEach is way too long; I know.
// Initializing query.Questions _should_ be above, in the `var` section, but there's
// no readable way to initialize Data ([255]byte); `copy()`, however, is readable
copy(nameArray[:], name)
query.Questions[0].Name = dnsmessage.Name{Length: uint8(len(name)), Data: nameArray}
query.ID = headerId
// Set up the DNS query
queryBuilder = dnsmessage.NewBuilder(nil, dnsmessage.Header{
ID: headerId,
Response: false,
OpCode: 0,
Authoritative: false,
Truncated: false,
RecursionDesired: true,
RecursionAvailable: false,
RCode: 0,
})
queryBuilder.EnableCompression()
question := dnsmessage.Question{
Name: dnsmessage.Name{
Data: nameArray,
Length: uint8(len(name)),
},
Type: dnsmessage.TypeA,
Class: dnsmessage.ClassINET,
}
err = queryBuilder.StartQuestions()
Expect(err).ToNot(HaveOccurred())
err = queryBuilder.Question(question)
Expect(err).ToNot(HaveOccurred())
packedQuery, err = queryBuilder.Finish()
Expect(err).ToNot(HaveOccurred())
var deleteMe dnsmessage.Message
err = deleteMe.Unpack(packedQuery)
// Put the finishing touches on the expected response
expectedResponse.ID = headerId
expectedResponse.Questions = query.Questions
expectedResponse.Answers[0].Header.Name = query.Questions[0].Name
packedQuery, err = query.Pack()
Expect(err).To(Not(HaveOccurred()))
expectedResponse.Questions = append(expectedResponse.Questions, question)
expectedResponse.Answers[0].Header.Name = question.Name
// The heart of the code: call QueryResponse()
packedResponse, err = xip.QueryResponse(packedQuery)
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
err = response.Unpack(packedResponse)
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
})
When("It cannot Unpack() the query", func() {
It("returns an error", func() {
@@ -95,31 +115,69 @@ var _ = Describe("Xip", func() {
})
})
It("should return the correct expectedResponse", func() {
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
// break the sections out to make debugging easier
Expect(response.Header).To(Equal(expectedResponse.Header))
Expect(response.Questions).To(Equal(expectedResponse.Questions))
Expect(response.Answers).To(Equal(expectedResponse.Answers))
Expect(response.Authorities).To(Equal(expectedResponse.Authorities))
Expect(response.Additionals).To(Equal(expectedResponse.Additionals))
// and now the whole enchilada
Expect(response).To(Equal(expectedResponse))
})
When("There is A record cannot be found", func() {
When("an A record cannot be found", func() {
BeforeEach(func() {
name = "not-an-ip.sslip.io."
copy(nameArray[:], name)
expectedSOA := xip.SOAResource(name)
expectedAuthority := dnsmessage.Resource{
Header: dnsmessage.ResourceHeader{
Name: dnsmessage.Name{
Data: nameArray,
Length: uint8(len(name)),
},
Type: dnsmessage.TypeSOA,
Class: dnsmessage.ClassINET,
TTL: 604800,
Length: 45,
},
Body: &expectedSOA,
}
expectedResponse.Authorities = append(expectedResponse.Authorities, expectedAuthority)
})
It("returns the no answers, but returns an authoritative section", func() {
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
Expect(response.Answers).To(Equal([]dnsmessage.Resource{}))
Expect(response.Authorities).To(Equal(xip.SOAResource(name)))
// break test down for easier debugging
Expect(len(response.Answers)).To(Equal(0))
Expect(len(response.Authorities)).To(Equal(1))
Expect(response.Authorities[0].Header.Name).To(Equal(expectedResponse.Authorities[0].Header.Name))
Expect(response.Authorities[0].Header).To(Equal(expectedResponse.Authorities[0].Header))
Expect(response.Authorities[0].Body).To(Equal(expectedResponse.Authorities[0].Body))
Expect(response.Authorities[0]).To(Equal(expectedResponse.Authorities[0]))
})
})
})
Describe("ResponseHeader()", func() {
It("returns a header with the ID", func() {
query.ID = uint16(rand.Int31())
Expect(xip.ResponseHeader(query.Header)).To(Equal(dnsmessage.Header{
ID: query.ID,
headerId = uint16(rand.Int31())
Expect(xip.ResponseHeader(dnsmessage.Header{
ID: headerId,
Response: false,
OpCode: 0,
Authoritative: false,
Truncated: false,
RecursionDesired: false,
RecursionAvailable: false,
RCode: 0,
})).To(Equal(dnsmessage.Header{
ID: headerId, // taken from the query
Response: true,
OpCode: 0,
Authoritative: true,
Truncated: false,
RecursionDesired: query.RecursionDesired,
RecursionDesired: false, // taken from the query
RecursionAvailable: false,
RCode: 0,
}))
@@ -130,7 +188,7 @@ var _ = Describe("Xip", func() {
DescribeTable("when it succeeds",
func(fqdn string, expectedA dnsmessage.AResource) {
ipv4Answer, err := xip.NameToA(fqdn)
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
Expect(*ipv4Answer).To(Equal(expectedA))
},
// dots
@@ -163,7 +221,7 @@ var _ = Describe("Xip", func() {
DescribeTable("when it succeeds",
func(fqdn string, expectedAAAA dnsmessage.AAAAResource) {
ipv6Answer, err := xip.NameToAAAA(fqdn)
Expect(err).To(Not(HaveOccurred()))
Expect(err).ToNot(HaveOccurred())
Expect(*ipv6Answer).To(Equal(expectedAAAA))
},
// dashes only