Split plugins into individual files

dnscrypt-proxy/plugin_block_ipv6.go

@@ -0,0 +1,43 @@
+package main
+
+import "github.com/miekg/dns"
+
+type PluginBlockIPv6 struct{}
+
+func (plugin *PluginBlockIPv6) Name() string {
+	return "block_ipv6"
+}
+
+func (plugin *PluginBlockIPv6) Description() string {
+	return "Immediately return a synthetic response to AAAA queries."
+}
+
+func (plugin *PluginBlockIPv6) Init(proxy *Proxy) error {
+	return nil
+}
+
+func (plugin *PluginBlockIPv6) Drop() error {
+	return nil
+}
+
+func (plugin *PluginBlockIPv6) Reload() error {
+	return nil
+}
+
+func (plugin *PluginBlockIPv6) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
+	questions := msg.Question
+	if len(questions) != 1 {
+		return nil
+	}
+	question := questions[0]
+	if question.Qclass != dns.ClassINET || question.Qtype != dns.TypeAAAA {
+		return nil
+	}
+	synth, err := EmptyResponseFromMessage(msg)
+	if err != nil {
+		return err
+	}
+	pluginsState.synthResponse = synth
+	pluginsState.action = PluginsActionSynth
+	return nil
+}

dnscrypt-proxy/plugin_cache.go

@@ -0,0 +1,150 @@
+package main
+
+import (
+	"crypto/sha512"
+	"encoding/binary"
+	"errors"
+	"sync"
+	"time"
+
+	lru "github.com/hashicorp/golang-lru"
+	"github.com/miekg/dns"
+)
+
+type CachedResponse struct {
+	expiration time.Time
+	msg        dns.Msg
+}
+
+type CachedResponses struct {
+	sync.RWMutex
+	cache *lru.ARCCache
+}
+
+var cachedResponses CachedResponses
+
+type PluginCacheResponse struct {
+	cachedResponses *CachedResponses
+}
+
+func (plugin *PluginCacheResponse) Name() string {
+	return "cache_response"
+}
+
+func (plugin *PluginCacheResponse) Description() string {
+	return "DNS cache (writer)."
+}
+
+func (plugin *PluginCacheResponse) Init(proxy *Proxy) error {
+	return nil
+}
+
+func (plugin *PluginCacheResponse) Drop() error {
+	return nil
+}
+
+func (plugin *PluginCacheResponse) Reload() error {
+	return nil
+}
+
+func (plugin *PluginCacheResponse) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
+	plugin.cachedResponses = &cachedResponses
+	if msg.Rcode == dns.RcodeServerFailure {
+		return nil
+	}
+	cacheKey, err := computeCacheKey(pluginsState, msg)
+	if err != nil {
+		return err
+	}
+	ttl := getMinTTL(msg, pluginsState.cacheMinTTL, pluginsState.cacheMaxTTL, pluginsState.cacheNegTTL)
+	cachedResponse := CachedResponse{
+		expiration: time.Now().Add(ttl),
+		msg:        *msg,
+	}
+	plugin.cachedResponses.Lock()
+	defer plugin.cachedResponses.Unlock()
+	if plugin.cachedResponses.cache == nil {
+		plugin.cachedResponses.cache, err = lru.NewARC(pluginsState.cacheSize)
+		if err != nil {
+			return err
+		}
+	}
+	plugin.cachedResponses.cache.Add(cacheKey, cachedResponse)
+	return nil
+}
+
+type PluginCache struct {
+	cachedResponses *CachedResponses
+}
+
+func (plugin *PluginCache) Name() string {
+	return "cache"
+}
+
+func (plugin *PluginCache) Description() string {
+	return "DNS cache (reader)."
+}
+
+func (plugin *PluginCache) Init(proxy *Proxy) error {
+	return nil
+}
+
+func (plugin *PluginCache) Drop() error {
+	return nil
+}
+
+func (plugin *PluginCache) Reload() error {
+	return nil
+}
+
+func (plugin *PluginCache) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
+	plugin.cachedResponses = &cachedResponses
+
+	cacheKey, err := computeCacheKey(pluginsState, msg)
+	if err != nil {
+		return nil
+	}
+	plugin.cachedResponses.RLock()
+	defer plugin.cachedResponses.RUnlock()
+	if plugin.cachedResponses.cache == nil {
+		return nil
+	}
+	cached_any, ok := plugin.cachedResponses.cache.Get(cacheKey)
+	if !ok {
+		return nil
+	}
+	cached := cached_any.(CachedResponse)
+	if time.Now().After(cached.expiration) {
+		return nil
+	}
+	synth := cached.msg
+	synth.Id = msg.Id
+	synth.Response = true
+	synth.Compress = true
+	synth.Question = msg.Question
+	pluginsState.synthResponse = &synth
+	pluginsState.action = PluginsActionSynth
+	return nil
+}
+
+func computeCacheKey(pluginsState *PluginsState, msg *dns.Msg) ([32]byte, error) {
+	questions := msg.Question
+	if len(questions) != 1 {
+		return [32]byte{}, errors.New("No question present")
+	}
+	question := questions[0]
+	h := sha512.New512_256()
+	var tmp [5]byte
+	binary.LittleEndian.PutUint16(tmp[0:2], question.Qtype)
+	binary.LittleEndian.PutUint16(tmp[2:4], question.Qclass)
+	if pluginsState.dnssec {
+		tmp[4] = 1
+	}
+	h.Write(tmp[:])
+	normalizedName := []byte(question.Name)
+	NormalizeName(&normalizedName)
+	h.Write(normalizedName)
+	var sum [32]byte
+	h.Sum(sum[:0])
+	return sum, nil
+}

dnscrypt-proxy/plugin_get_set_payload_size.go

@@ -0,0 +1,48 @@
+package main
+
+import "github.com/miekg/dns"
+
+type PluginGetSetPayloadSize struct{}
+
+func (plugin *PluginGetSetPayloadSize) Name() string {
+	return "get_set_payload_size"
+}
+
+func (plugin *PluginGetSetPayloadSize) Description() string {
+	return "Adjusts the maximum payload size advertised in queries sent to upstream servers."
+}
+
+func (plugin *PluginGetSetPayloadSize) Init(proxy *Proxy) error {
+	return nil
+}
+
+func (plugin *PluginGetSetPayloadSize) Drop() error {
+	return nil
+}
+
+func (plugin *PluginGetSetPayloadSize) Reload() error {
+	return nil
+}
+
+func (plugin *PluginGetSetPayloadSize) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
+	pluginsState.originalMaxPayloadSize = 512 - ResponseOverhead
+	opt := msg.IsEdns0()
+	dnssec := false
+	if opt != nil {
+		pluginsState.originalMaxPayloadSize = Min(int(opt.UDPSize())-ResponseOverhead, pluginsState.originalMaxPayloadSize)
+		dnssec = opt.Do()
+	}
+	pluginsState.dnssec = dnssec
+	pluginsState.maxPayloadSize = Min(MaxDNSUDPPacketSize-ResponseOverhead, Max(pluginsState.originalMaxPayloadSize, pluginsState.maxPayloadSize))
+	if pluginsState.maxPayloadSize > 512 {
+		extra2 := []dns.RR{}
+		for _, extra := range msg.Extra {
+			if extra.Header().Rrtype != dns.TypeOPT {
+				extra2 = append(extra2, extra)
+			}
+		}
+		msg.Extra = extra2
+		msg.SetEdns0(uint16(pluginsState.maxPayloadSize), dnssec)
+	}
+	return nil
+}

dnscrypt-proxy/plugin_query_log.go

@@ -0,0 +1,91 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"net"
+	"os"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/jedisct1/dlog"
+	"github.com/miekg/dns"
+)
+
+type PluginQueryLog struct {
+	sync.Mutex
+	outFd  *os.File
+	format string
+}
+
+func (plugin *PluginQueryLog) Name() string {
+	return "query_log"
+}
+
+func (plugin *PluginQueryLog) Description() string {
+	return "Log DNS queries."
+}
+
+func (plugin *PluginQueryLog) Init(proxy *Proxy) error {
+	plugin.Lock()
+	defer plugin.Unlock()
+	outFd, err := os.OpenFile(proxy.queryLogFile, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
+	if err != nil {
+		return err
+	}
+	plugin.outFd = outFd
+	plugin.format = proxy.queryLogFormat
+
+	return nil
+}
+
+func (plugin *PluginQueryLog) Drop() error {
+	return nil
+}
+
+func (plugin *PluginQueryLog) Reload() error {
+	return nil
+}
+
+func (plugin *PluginQueryLog) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
+	questions := msg.Question
+	if len(questions) == 0 {
+		return nil
+	}
+	question := questions[0]
+	var clientIPStr string
+	if pluginsState.clientProto == "udp" {
+		clientIPStr = (*pluginsState.clientAddr).(*net.UDPAddr).IP.String()
+	} else {
+		clientIPStr = (*pluginsState.clientAddr).(*net.TCPAddr).IP.String()
+	}
+	qName := question.Name
+	if len(qName) > 1 && strings.HasSuffix(qName, ".") {
+		qName = qName[0 : len(qName)-1]
+	}
+	qType, ok := dns.TypeToString[question.Qtype]
+	if !ok {
+		qType = string(qType)
+	}
+	var line string
+	if plugin.format == "tsv" {
+		now := time.Now()
+		year, month, day := now.Date()
+		hour, minute, second := now.Clock()
+		tsStr := fmt.Sprintf("[%d-%02d-%02d %02d:%02d:%02d]", year, int(month), day, hour, minute, second)
+		line = fmt.Sprintf("%s\t%s\t%s\t%s\n", tsStr, clientIPStr, qName, qType)
+	} else if plugin.format == "ltsv" {
+		line = fmt.Sprintf("time:%d\thost:%s\tmessage:%s\ttype:%s\n",
+			time.Now().Unix(), clientIPStr, qName, qType)
+	} else {
+		dlog.Fatalf("Unexpected log format: [%s]", plugin.format)
+	}
+	plugin.Lock()
+	if plugin.outFd == nil {
+		return errors.New("Log file not initialized")
+	}
+	plugin.outFd.WriteString(line)
+	defer plugin.Unlock()
+	return nil
+}

dnscrypt-proxy/plugins.go

@@ -1,18 +1,9 @@
 package main
 
 import (
-	"crypto/sha512"
-	"encoding/binary"
-	"errors"
-	"fmt"
 	"net"
-	"os"
-	"strings"
 	"sync"
-	"time"
 
-	lru "github.com/hashicorp/golang-lru"
-	"github.com/jedisct1/dlog"
 	"github.com/miekg/dns"
 )
 
@@ -103,8 +94,6 @@ func NewPluginsState(proxy *Proxy, clientProto string, clientAddr *net.Addr) Plu
 	}
 }
 
-// ---------------- Query plugins ----------------
-
 func (pluginsState *PluginsState) ApplyQueryPlugins(pluginsGlobals *PluginsGlobals, packet []byte) ([]byte, error) {
 	if len(*pluginsGlobals.queryPlugins) == 0 {
 		return packet, nil
@@ -133,176 +122,6 @@ func (pluginsState *PluginsState) ApplyQueryPlugins(pluginsGlobals *PluginsGloba
 	return packet2, nil
 }
 
-// -------- get_set_payload_size plugin --------
-
-type PluginGetSetPayloadSize struct{}
-
-func (plugin *PluginGetSetPayloadSize) Name() string {
-	return "get_set_payload_size"
-}
-
-func (plugin *PluginGetSetPayloadSize) Description() string {
-	return "Adjusts the maximum payload size advertised in queries sent to upstream servers."
-}
-
-func (plugin *PluginGetSetPayloadSize) Init(proxy *Proxy) error {
-	return nil
-}
-
-func (plugin *PluginGetSetPayloadSize) Drop() error {
-	return nil
-}
-
-func (plugin *PluginGetSetPayloadSize) Reload() error {
-	return nil
-}
-
-func (plugin *PluginGetSetPayloadSize) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
-	pluginsState.originalMaxPayloadSize = 512 - ResponseOverhead
-	opt := msg.IsEdns0()
-	dnssec := false
-	if opt != nil {
-		pluginsState.originalMaxPayloadSize = Min(int(opt.UDPSize())-ResponseOverhead, pluginsState.originalMaxPayloadSize)
-		dnssec = opt.Do()
-	}
-	pluginsState.dnssec = dnssec
-	pluginsState.maxPayloadSize = Min(MaxDNSUDPPacketSize-ResponseOverhead, Max(pluginsState.originalMaxPayloadSize, pluginsState.maxPayloadSize))
-	if pluginsState.maxPayloadSize > 512 {
-		extra2 := []dns.RR{}
-		for _, extra := range msg.Extra {
-			if extra.Header().Rrtype != dns.TypeOPT {
-				extra2 = append(extra2, extra)
-			}
-		}
-		msg.Extra = extra2
-		msg.SetEdns0(uint16(pluginsState.maxPayloadSize), dnssec)
-	}
-	return nil
-}
-
-// -------- block_ipv6 plugin --------
-
-type PluginBlockIPv6 struct{}
-
-func (plugin *PluginBlockIPv6) Name() string {
-	return "block_ipv6"
-}
-
-func (plugin *PluginBlockIPv6) Description() string {
-	return "Immediately return a synthetic response to AAAA queries."
-}
-
-func (plugin *PluginBlockIPv6) Init(proxy *Proxy) error {
-	return nil
-}
-
-func (plugin *PluginBlockIPv6) Drop() error {
-	return nil
-}
-
-func (plugin *PluginBlockIPv6) Reload() error {
-	return nil
-}
-
-func (plugin *PluginBlockIPv6) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
-	questions := msg.Question
-	if len(questions) != 1 {
-		return nil
-	}
-	question := questions[0]
-	if question.Qclass != dns.ClassINET || question.Qtype != dns.TypeAAAA {
-		return nil
-	}
-	synth, err := EmptyResponseFromMessage(msg)
-	if err != nil {
-		return err
-	}
-	pluginsState.synthResponse = synth
-	pluginsState.action = PluginsActionSynth
-	return nil
-}
-
-// -------- querylog plugin --------
-
-type PluginQueryLog struct {
-	sync.Mutex
-	outFd  *os.File
-	format string
-}
-
-func (plugin *PluginQueryLog) Name() string {
-	return "querylog"
-}
-
-func (plugin *PluginQueryLog) Description() string {
-	return "Log DNS queries."
-}
-
-func (plugin *PluginQueryLog) Init(proxy *Proxy) error {
-	plugin.Lock()
-	defer plugin.Unlock()
-	outFd, err := os.OpenFile(proxy.queryLogFile, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
-	if err != nil {
-		return err
-	}
-	plugin.outFd = outFd
-	plugin.format = proxy.queryLogFormat
-
-	return nil
-}
-
-func (plugin *PluginQueryLog) Drop() error {
-	return nil
-}
-
-func (plugin *PluginQueryLog) Reload() error {
-	return nil
-}
-
-func (plugin *PluginQueryLog) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
-	questions := msg.Question
-	if len(questions) == 0 {
-		return nil
-	}
-	question := questions[0]
-	var clientIPStr string
-	if pluginsState.clientProto == "udp" {
-		clientIPStr = (*pluginsState.clientAddr).(*net.UDPAddr).IP.String()
-	} else {
-		clientIPStr = (*pluginsState.clientAddr).(*net.TCPAddr).IP.String()
-	}
-	qName := question.Name
-	if len(qName) > 1 && strings.HasSuffix(qName, ".") {
-		qName = qName[0 : len(qName)-1]
-	}
-	qType, ok := dns.TypeToString[question.Qtype]
-	if !ok {
-		qType = string(qType)
-	}
-	var line string
-	if plugin.format == "tsv" {
-		now := time.Now()
-		year, month, day := now.Date()
-		hour, minute, second := now.Clock()
-		tsStr := fmt.Sprintf("[%d-%02d-%02d %02d:%02d:%02d]", year, int(month), day, hour, minute, second)
-		line = fmt.Sprintf("%s\t%s\t%s\t%s\n", tsStr, clientIPStr, qName, qType)
-	} else if plugin.format == "ltsv" {
-		line = fmt.Sprintf("time:%d\thost:%s\tmessage:%s\ttype:%s\n",
-			time.Now().Unix(), clientIPStr, qName, qType)
-	} else {
-		dlog.Fatalf("Unexpected log format: [%s]", plugin.format)
-	}
-	plugin.Lock()
-	if plugin.outFd == nil {
-		return errors.New("Log file not initialized")
-	}
-	plugin.outFd.WriteString(line)
-	defer plugin.Unlock()
-	return nil
-}
-
-// ---------------- Response plugins ----------------
-
 func (pluginsState *PluginsState) ApplyResponsePlugins(pluginsGlobals *PluginsGlobals, packet []byte) ([]byte, error) {
 	if len(*pluginsGlobals.responsePlugins) == 0 {
 		return packet, nil
@@ -330,143 +149,3 @@ func (pluginsState *PluginsState) ApplyResponsePlugins(pluginsGlobals *PluginsGl
 	}
 	return packet2, nil
 }
-
-// -------- cache plugin --------
-
-type CachedResponse struct {
-	expiration time.Time
-	msg        dns.Msg
-}
-
-type CachedResponses struct {
-	sync.RWMutex
-	cache *lru.ARCCache
-}
-
-var cachedResponses CachedResponses
-
-type PluginCacheResponse struct {
-	cachedResponses *CachedResponses
-}
-
-func (plugin *PluginCacheResponse) Name() string {
-	return "cache_response"
-}
-
-func (plugin *PluginCacheResponse) Description() string {
-	return "DNS cache (writer)."
-}
-
-func (plugin *PluginCacheResponse) Init(proxy *Proxy) error {
-	return nil
-}
-
-func (plugin *PluginCacheResponse) Drop() error {
-	return nil
-}
-
-func (plugin *PluginCacheResponse) Reload() error {
-	return nil
-}
-
-func (plugin *PluginCacheResponse) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
-	plugin.cachedResponses = &cachedResponses
-	if msg.Rcode == dns.RcodeServerFailure {
-		return nil
-	}
-	cacheKey, err := computeCacheKey(pluginsState, msg)
-	if err != nil {
-		return err
-	}
-	ttl := getMinTTL(msg, pluginsState.cacheMinTTL, pluginsState.cacheMaxTTL, pluginsState.cacheNegTTL)
-	cachedResponse := CachedResponse{
-		expiration: time.Now().Add(ttl),
-		msg:        *msg,
-	}
-	plugin.cachedResponses.Lock()
-	defer plugin.cachedResponses.Unlock()
-	if plugin.cachedResponses.cache == nil {
-		plugin.cachedResponses.cache, err = lru.NewARC(pluginsState.cacheSize)
-		if err != nil {
-			return err
-		}
-	}
-	plugin.cachedResponses.cache.Add(cacheKey, cachedResponse)
-	return nil
-}
-
-type PluginCache struct {
-	cachedResponses *CachedResponses
-}
-
-func (plugin *PluginCache) Name() string {
-	return "cache"
-}
-
-func (plugin *PluginCache) Description() string {
-	return "DNS cache (reader)."
-}
-
-func (plugin *PluginCache) Init(proxy *Proxy) error {
-	return nil
-}
-
-func (plugin *PluginCache) Drop() error {
-	return nil
-}
-
-func (plugin *PluginCache) Reload() error {
-	return nil
-}
-
-func (plugin *PluginCache) Eval(pluginsState *PluginsState, msg *dns.Msg) error {
-	plugin.cachedResponses = &cachedResponses
-
-	cacheKey, err := computeCacheKey(pluginsState, msg)
-	if err != nil {
-		return nil
-	}
-	plugin.cachedResponses.RLock()
-	defer plugin.cachedResponses.RUnlock()
-	if plugin.cachedResponses.cache == nil {
-		return nil
-	}
-	cached_any, ok := plugin.cachedResponses.cache.Get(cacheKey)
-	if !ok {
-		return nil
-	}
-	cached := cached_any.(CachedResponse)
-	if time.Now().After(cached.expiration) {
-		return nil
-	}
-	synth := cached.msg
-	synth.Id = msg.Id
-	synth.Response = true
-	synth.Compress = true
-	synth.Question = msg.Question
-	pluginsState.synthResponse = &synth
-	pluginsState.action = PluginsActionSynth
-	return nil
-}
-
-func computeCacheKey(pluginsState *PluginsState, msg *dns.Msg) ([32]byte, error) {
-	questions := msg.Question
-	if len(questions) != 1 {
-		return [32]byte{}, errors.New("No question present")
-	}
-	question := questions[0]
-	h := sha512.New512_256()
-	var tmp [5]byte
-	binary.LittleEndian.PutUint16(tmp[0:2], question.Qtype)
-	binary.LittleEndian.PutUint16(tmp[2:4], question.Qclass)
-	if pluginsState.dnssec {
-		tmp[4] = 1
-	}
-	h.Write(tmp[:])
-	normalizedName := []byte(question.Name)
-	NormalizeName(&normalizedName)
-	h.Write(normalizedName)
-	var sum [32]byte
-	h.Sum(sum[:0])
-	return sum, nil
-}