├── .gitignore
├── bundle.sh
├── config.go
├── delegate.go
├── go.mod
├── go.sum
├── images
    └── fairymq.png
├── license
├── main.go
├── main_test.go
├── memberlist.go
├── queue-keys
    ├── queue_keys.go
    └── queue_keys_test.go
└── readme.md


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | keys
3 | fairymq
4 | fairymq.exe
5 | bin
6 | snapshots


--------------------------------------------------------------------------------
/bundle.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | VERSION=v1.2.1
 3 | 
 4 | echo "Bundling fairyMQ $VERSION"
 5 | 
 6 | ( GOOS=darwin GOARCH=amd64 go build -o bin/macos-darwin/amd64/fairymq && tar -czf bin/macos-darwin/amd64/fairymq-$VERSION-amd64.tar.gz -C bin/macos-darwin/amd64/ $(ls  bin/macos-darwin/amd64/))
 7 | ( GOOS=darwin GOARCH=arm64 go build -o bin/macos-darwin/arm64/fairymq && tar -czf bin/macos-darwin/arm64/fairymq-$VERSION-arm64.tar.gz -C bin/macos-darwin/arm64/ $(ls  bin/macos-darwin/arm64/))
 8 | ( GOOS=linux GOARCH=386 go build -o bin/linux/386/fairymq && tar -czf bin/linux/386/fairymq-$VERSION-386.tar.gz -C bin/linux/386/ $(ls  bin/linux/386/))
 9 | ( GOOS=linux GOARCH=amd64 go build -o bin/linux/amd64/fairymq && tar -czf bin/linux/amd64/fairymq-$VERSION-amd64.tar.gz -C bin/linux/amd64/ $(ls  bin/linux/amd64/))
10 | ( GOOS=linux GOARCH=arm go build -o bin/linux/arm/fairymq && tar -czf bin/linux/arm/fairymq-$VERSION-arm.tar.gz -C bin/linux/arm/ $(ls  bin/linux/arm/))
11 | ( GOOS=linux GOARCH=arm64 go build -o bin/linux/arm64/fairymq && tar -czf bin/linux/arm64/fairymq-$VERSION-arm64.tar.gz -C bin/linux/arm64/ $(ls  bin/linux/arm64/))
12 | ( GOOS=freebsd GOARCH=arm go build -o bin/freebsd/arm/fairymq && tar -czf bin/freebsd/arm/fairymq-$VERSION-arm.tar.gz -C bin/freebsd/arm/ $(ls  bin/freebsd/arm/))
13 | ( GOOS=freebsd GOARCH=amd64 go build -o bin/freebsd/amd64/fairymq && tar -czf bin/freebsd/amd64/fairymq-$VERSION-amd64.tar.gz -C bin/freebsd/amd64/ $(ls  bin/freebsd/amd64/))
14 | ( GOOS=freebsd GOARCH=386 go build -o bin/freebsd/386/fairymq && tar -czf bin/freebsd/386/fairymq-$VERSION-386.tar.gz -C bin/freebsd/386/ $(ls  bin/freebsd/386/))
15 | ( GOOS=windows GOARCH=amd64 go build -o bin/windows/amd64/fairymq.exe && zip -r -j bin/windows/amd64/fairymq-$VERSION-x64.zip bin/windows/amd64/fairymq.exe)
16 | ( GOOS=windows GOARCH=arm64 go build -o bin/windows/arm64/fairymq.exe && zip -r -j bin/windows/arm64/fairymq-$VERSION-x64.zip bin/windows/arm64/fairymq.exe)
17 | ( GOOS=windows GOARCH=386 go build -o bin/windows/386/fairymq.exe && zip -r -j bin/windows/386/fairymq-$VERSION-x86.zip bin/windows/386/fairymq.exe)
18 | 
19 | 
20 | echo "Fin"


--------------------------------------------------------------------------------
/config.go:
--------------------------------------------------------------------------------
 1 | package main
 2 | 
 3 | import (
 4 | 	"flag"
 5 | 	"slices"
 6 | 	"time"
 7 | )
 8 | 
 9 | type Config struct {
10 | 	BindAddress           string
11 | 	BindPort              uint
12 | 	MemberlistPort        uint
13 | 	GenerateQueueKeyPairs []string
14 | 	JoinAddresses         []string
15 | 	PushPullInterval      time.Duration
16 | 	KeyDirectory          string
17 | 	keySyncInterval       time.Duration
18 | }
19 | 
20 | func GetConfig() Config {
21 | 	var joinAddresses []string
22 | 	flag.Func(
23 | 		"join-address",
24 | 		"IP address and memberlist port of a peer in a cluster we would like to join. This flag can be specified multiple times.   --join-address=<ipaddress>:<memberlist-port>",
25 | 		func(address string) error {
26 | 			joinAddresses = append(joinAddresses, address)
27 | 			return nil
28 | 		})
29 | 
30 | 	var generateQueueKeyPairs []string
31 | 	flag.Func("generate-queue-key-pair", "Generates a new queue keypair.   --generate-queue-key-pair=yourqueuename", func(queue string) error {
32 | 		if !slices.Contains(generateQueueKeyPairs, queue) {
33 | 			generateQueueKeyPairs = append(generateQueueKeyPairs, queue)
34 | 		}
35 | 		return nil
36 | 	})
37 | 
38 | 	pushPullInterval := flag.Duration("push-pull-interval", 30*time.Second, "Set the state push-pull interval for merging states between nodes in the cluster. Default is 30 seconds.   --push-pull-interval=30s")
39 | 	bindAddress := flag.String("bind-address", "0.0.0.0", "The host address to bind to.   --bind-address=0.0.0.0")
40 | 	bindPort := flag.Uint("bind-port", 5991, "The port to bind to.   --bind-port=5991")
41 | 	memberlistPort := flag.Uint("memberlist-port", 7946, "Port used by this node to communicate with other nodes in the cluster.   --memberlist-port=7946")
42 | 	keyDirectory := flag.String("key-directory", "./keys", "The directory used to store the generated queue keys.   ---key-directory=keys")
43 | 	keySyncInterval := flag.Duration("key-sync-interval", 5*time.Second, "The interval between syncing the private keys from the key directory to the in-memory map.   --key-sync-interval=5s")
44 | 
45 | 	flag.Parse()
46 | 
47 | 	config := Config{
48 | 		BindAddress:           *bindAddress,
49 | 		BindPort:              *bindPort,
50 | 		MemberlistPort:        *memberlistPort,
51 | 		PushPullInterval:      *pushPullInterval,
52 | 		GenerateQueueKeyPairs: generateQueueKeyPairs,
53 | 		JoinAddresses:         joinAddresses,
54 | 		KeyDirectory:          *keyDirectory,
55 | 		keySyncInterval:       *keySyncInterval,
56 | 	}
57 | 
58 | 	return config
59 | }
60 | 


--------------------------------------------------------------------------------
/delegate.go:
--------------------------------------------------------------------------------
  1 | package main
  2 | 
  3 | import (
  4 | 	"bytes"
  5 | 	"encoding/json"
  6 | 	"fmt"
  7 | 	"log"
  8 | 	"slices"
  9 | 	"sync"
 10 | 	"time"
 11 | )
 12 | 
 13 | type SyncQueue struct {
 14 | 	Name           string        `json:"Name"`
 15 | 	ExpireMessages bool          `json:"ExpireMessages"`
 16 | 	ExpiryTime     uint          `json:"ExpiryTime"`
 17 | 	Messages       []SyncMessage `json:"Messages"`
 18 | }
 19 | 
 20 | type SyncMessage struct {
 21 | 	Key       string    `json:"Key"`
 22 | 	Data      []byte    `json:"Data"`
 23 | 	Timestamp time.Time `json:"Timestamp"`
 24 | }
 25 | 
 26 | type NodeMeta struct {
 27 | 	Name           string
 28 | 	BindAddress    string
 29 | 	MemberlistPort uint
 30 | }
 31 | 
 32 | type Delegate struct {
 33 | 	fairyMQ *FairyMQ
 34 | }
 35 | 
 36 | func (delegate *Delegate) NodeMeta(limit int) []byte {
 37 | 	meta := NodeMeta{
 38 | 		Name:           fmt.Sprintf("%s:%d", delegate.fairyMQ.Config.BindAddress, delegate.fairyMQ.Config.MemberlistPort),
 39 | 		BindAddress:    delegate.fairyMQ.Config.BindAddress,
 40 | 		MemberlistPort: delegate.fairyMQ.Config.MemberlistPort,
 41 | 	}
 42 | 	mb := make([]byte, limit)
 43 | 	mb, err := json.Marshal(meta)
 44 | 	if err != nil {
 45 | 		log.Println("Error: ", err)
 46 | 		return []byte{}
 47 | 	}
 48 | 	return mb
 49 | }
 50 | 
 51 | func (delegate *Delegate) NotifyMsg([]byte) {
 52 | 	// No-Op
 53 | }
 54 | 
 55 | func (delegate *Delegate) GetBroadcasts(overhead, limit int) [][]byte {
 56 | 	// No-Op
 57 | 	return [][]byte{}
 58 | }
 59 | 
 60 | func (delegate *Delegate) LocalState(join bool) []byte {
 61 | 	var queues []SyncQueue
 62 | 
 63 | 	for queueName, mut := range fairyMQ.QueueMutexes {
 64 | 		mut.Lock()
 65 | 
 66 | 		// Extract messages from queue
 67 | 		var messages []SyncMessage
 68 | 		for _, m := range fairyMQ.Queues[queueName].Messages {
 69 | 			messages = append(messages, SyncMessage{
 70 | 				Key:       m.Key,
 71 | 				Data:      m.Data,
 72 | 				Timestamp: m.Timestamp,
 73 | 			})
 74 | 		}
 75 | 
 76 | 		queues = append(queues, SyncQueue{
 77 | 			Name:           queueName,
 78 | 			ExpireMessages: fairyMQ.Queues[queueName].ExpireMessages,
 79 | 			ExpiryTime:     fairyMQ.Queues[queueName].ExpiryTime,
 80 | 			Messages:       messages,
 81 | 		})
 82 | 		mut.Unlock()
 83 | 	}
 84 | 
 85 | 	b, err := json.Marshal(queues)
 86 | 	if err != nil {
 87 | 		log.Println("Could not encode state for sync: ", err.Error())
 88 | 		return []byte{}
 89 | 	}
 90 | 
 91 | 	return b
 92 | }
 93 | 
 94 | func (delegate *Delegate) MergeRemoteState(buf []byte, join bool) {
 95 | 	var queues []SyncQueue
 96 | 
 97 | 	err := json.Unmarshal(buf, &queues)
 98 | 	if err != nil {
 99 | 		log.Println("Could not decode state for merge: ", err.Error())
100 | 		return
101 | 	}
102 | 
103 | 	for _, q := range queues {
104 | 		var messages []Message
105 | 		mut, ok := fairyMQ.QueueMutexes[q.Name]
106 | 
107 | 		if !ok { // If queue does not exist, add it.
108 | 			for _, m := range q.Messages {
109 | 				messages = append(messages, Message{
110 | 					Key:                   m.Key,
111 | 					Data:                  m.Data,
112 | 					Timestamp:             m.Timestamp,
113 | 					AcknowledgedConsumers: []Consumer{},
114 | 				})
115 | 			}
116 | 
117 | 			fairyMQ.QueueMutexes[q.Name] = &sync.Mutex{}
118 | 			fairyMQ.QueueMutexes[q.Name].Lock()
119 | 
120 | 			fairyMQ.Queues[q.Name] = &Queue{
121 | 				ExpireMessages: q.ExpireMessages,
122 | 				ExpiryTime:     q.ExpiryTime,
123 | 				Messages:       messages,
124 | 				Consumers:      []string{},
125 | 			}
126 | 
127 | 			fairyMQ.QueueMutexes[q.Name].Unlock()
128 | 			continue
129 | 		}
130 | 
131 | 		// If queue exists, merge the messages.
132 | 		mut.Lock()
133 | 		for _, m := range q.Messages {
134 | 			msgIdx := slices.IndexFunc(fairyMQ.Queues[q.Name].Messages, func(message Message) bool {
135 | 				return (m.Key == message.Key) && (m.Timestamp == message.Timestamp) && bytes.Equal(m.Data, message.Data)
136 | 			})
137 | 			if msgIdx == -1 {
138 | 				// Current message is not contained in the messages, add the message
139 | 				fairyMQ.Queues[q.Name].Messages = append(fairyMQ.Queues[q.Name].Messages, Message{
140 | 					Key:                   m.Key,
141 | 					Data:                  m.Data,
142 | 					Timestamp:             m.Timestamp,
143 | 					AcknowledgedConsumers: []Consumer{},
144 | 				})
145 | 			}
146 | 		}
147 | 		// Sort the messages by timestamp
148 | 		slices.SortFunc(fairyMQ.Queues[q.Name].Messages, func(a, b Message) int {
149 | 			switch {
150 | 			case a.Timestamp.Before(b.Timestamp):
151 | 				return 1
152 | 			case a.Timestamp.After(b.Timestamp):
153 | 				return -1
154 | 			default:
155 | 				return 0
156 | 			}
157 | 		})
158 | 		mut.Unlock()
159 | 	}
160 | }
161 | 


--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
 1 | module fairymq
 2 | 
 3 | go 1.21.3
 4 | 
 5 | require (
 6 | 	github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect
 7 | 	github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c // indirect
 8 | 	github.com/hashicorp/errwrap v1.0.0 // indirect
 9 | 	github.com/hashicorp/go-immutable-radix v1.0.0 // indirect
10 | 	github.com/hashicorp/go-msgpack v0.5.3 // indirect
11 | 	github.com/hashicorp/go-multierror v1.0.0 // indirect
12 | 	github.com/hashicorp/go-sockaddr v1.0.0 // indirect
13 | 	github.com/hashicorp/golang-lru v0.5.0 // indirect
14 | 	github.com/hashicorp/memberlist v0.5.0 // indirect
15 | 	github.com/miekg/dns v1.1.26 // indirect
16 | 	github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 // indirect
17 | 	golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392 // indirect
18 | 	golang.org/x/net v0.0.0-20190923162816-aa69164e4478 // indirect
19 | 	golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10 // indirect
20 | )
21 | 


--------------------------------------------------------------------------------
/go.sum:
--------------------------------------------------------------------------------
 1 | github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da h1:8GUt8eRujhVEGZFFEjBj46YV4rDjvGrNxb0KMWYkL2I=
 2 | github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY=
 3 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 4 | github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c h1:964Od4U6p2jUkFxvCydnIczKteheJEzHRToSGK3Bnlw=
 5 | github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 6 | github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA=
 7 | github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 8 | github.com/hashicorp/go-immutable-radix v1.0.0 h1:AKDB1HM5PWEA7i4nhcpwOrO2byshxBjXVn/J/3+z5/0=
 9 | github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60=
10 | github.com/hashicorp/go-msgpack v0.5.3 h1:zKjpN5BK/P5lMYrLmBHdBULWbJ0XpYR+7NGzqkZzoD4=
11 | github.com/hashicorp/go-msgpack v0.5.3/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM=
12 | github.com/hashicorp/go-multierror v1.0.0 h1:iVjPR7a6H0tWELX5NxNe7bYopibicUzc7uPribsnS6o=
13 | github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
14 | github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs=
15 | github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU=
16 | github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
17 | github.com/hashicorp/golang-lru v0.5.0 h1:CL2msUPvZTLb5O648aiLNJw3hnBxN2+1Jq8rCOH9wdo=
18 | github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
19 | github.com/hashicorp/memberlist v0.5.0 h1:EtYPN8DpAURiapus508I4n9CzHs2W+8NZGbmmR/prTM=
20 | github.com/hashicorp/memberlist v0.5.0/go.mod h1:yvyXLpo0QaGE59Y7hDTsTzDD25JYBZ4mHgHUZ8lrOI0=
21 | github.com/miekg/dns v1.1.26 h1:gPxPSwALAeHJSjarOs00QjVdV9QoBvc1D2ujQUr5BzU=
22 | github.com/miekg/dns v1.1.26/go.mod h1:bPDLeHnStXmXAq1m/Ch/hvfNHr14JKNPMBo3VZKjuso=
23 | github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
24 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
25 | github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 h1:nn5Wsu0esKSJiIVhscUtVbo7ada43DJhG55ua/hjS5I=
26 | github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc=
27 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
28 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
29 | golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392 h1:ACG4HJsFiNMf47Y4PeRoebLNy/2lXT9EtprMuTFWt1M=
30 | golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392/go.mod h1:/lpIB1dKB+9EgE3H3cr1v9wB50oz8l4C4h62xy7jSTY=
31 | golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
32 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
33 | golang.org/x/net v0.0.0-20190923162816-aa69164e4478 h1:l5EDrHhldLYb3ZRHDUhXF7Om7MvYXnkV9/iQNo1lX6g=
34 | golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
35 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
36 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
37 | golang.org/x/sys v0.0.0-20190922100055-0a153f010e69/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
38 | golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
39 | golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10 h1:WIoqL4EROvwiPdUtaip4VcDdpZ4kha7wBWZrbVKCIZg=
40 | golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
41 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
42 | golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
43 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
44 | golang.org/x/tools v0.0.0-20190907020128-2ca718005c18/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
45 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
46 | 


--------------------------------------------------------------------------------
/images/fairymq.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fairymq/fairymq/cf9e6108a3521b88ff2ff5d73780011ddb25d7c0/images/fairymq.png


--------------------------------------------------------------------------------
/license:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.


--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
  1 | /*
  2 | * fairyMQ
  3 | * Core
  4 | * ******************************************************************
  5 | * Originally authored by Alex Gaetano Padula
  6 | * Copyright (C) fairyMQ
  7 | *
  8 | * This program is free software: you can redistribute it and/or modify
  9 | * it under the terms of the GNU General Public License as published by
 10 | * the Free Software Foundation, either version 3 of the License, or
 11 | * (at your option) any later version.
 12 | *
 13 | * This program is distributed in the hope that it will be useful,
 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16 | * GNU General Public License for more details.
 17 | *
 18 | * You should have received a copy of the GNU General Public License
 19 | * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 20 |  */
 21 | package main
 22 | 
 23 | import (
 24 | 	"bufio"
 25 | 	"bytes"
 26 | 	"context"
 27 | 	"crypto/rand"
 28 | 	"crypto/rsa"
 29 | 	"crypto/x509"
 30 | 	"encoding/gob"
 31 | 	"encoding/pem"
 32 | 	keys "fairymq/queue-keys"
 33 | 	"fmt"
 34 | 	"log"
 35 | 	"net"
 36 | 	"os"
 37 | 	"os/signal"
 38 | 	"sort"
 39 | 	"strconv"
 40 | 	"strings"
 41 | 	"sync"
 42 | 	"syscall"
 43 | 	"time"
 44 | )
 45 | 
 46 | // FairyMQ is the fairyMQ system structure
 47 | type FairyMQ struct {
 48 | 	UDPAddr                *net.UDPAddr             // UDP address representation
 49 | 	Conn                   *net.UDPConn             // Conn is the implementation of the Conn and PacketConn interfaces for UDP network connections
 50 | 	Wg                     *sync.WaitGroup          // WaitGroup pointer
 51 | 	SignalChannel          chan os.Signal           // Signal channel
 52 | 	Queues                 map[string]*Queue        // In-memory queues
 53 | 	Consumers              []Consumer               // Consumer
 54 | 	ContextCancel          context.CancelFunc       // To cancel on signal
 55 | 	Context                context.Context          // For signal cancellation
 56 | 	QueueMutexes           map[string]*sync.Mutex   // Individual queue mutexes
 57 | 	Config                 Config                   // Server configuration
 58 | 	MemberlistShutdownFunc func() error             // Function called when withdrawing memberlist cluster membership
 59 | 	PrivateKeys            keys.PrivateKeyContainer // Handles all private key functionality
 60 | }
 61 | 
 62 | // Queue is the fairyMQ queue structure
 63 | type Queue struct {
 64 | 	ExpireMessages bool      // Expire messages and delete from queue
 65 | 	ExpiryTime     uint      // Expiry in seconds; Default is 7200 (2 hours)
 66 | 	Messages       []Message // Queue messages
 67 | 	Consumers      []string  // Consumer addresses
 68 | }
 69 | 
 70 | // Consumer is a queue consumer
 71 | type Consumer struct {
 72 | 	Queue   string // Name of queue
 73 | 	Address string // Consumer address i.e 0.0.0.0:5992
 74 | }
 75 | 
 76 | // Message is a queue message
 77 | type Message struct {
 78 | 	Key                   string     // Message key default is empty but can be provided by client to be able to search
 79 | 	Data                  []byte     // Message data
 80 | 	Timestamp             time.Time  // Message timestamp
 81 | 	AcknowledgedConsumers []Consumer // Which consumers acknowledged this message? if any
 82 | }
 83 | 
 84 | // Global variables
 85 | var (
 86 | 	fairyMQ *FairyMQ // Main fairyMQ pointer
 87 | )
 88 | 
 89 | func main() {
 90 | 	config := GetConfig()
 91 | 
 92 | 	fairyMQ = &FairyMQ{
 93 | 		Wg:            &sync.WaitGroup{},            // Setting WaitGroup pointer to hold go routines
 94 | 		SignalChannel: make(chan os.Signal, 1),      // Make signal channel
 95 | 		Queues:        make(map[string]*Queue),      // Make queues in-memory hashmap
 96 | 		QueueMutexes:  make(map[string]*sync.Mutex), // Make queue mutexes hashmap
 97 | 		Config:        config,
 98 | 		PrivateKeys: keys.NewDefaultPrivateKeyContainer(keys.PrivateKeyConfig{
 99 | 			KeyDirectory: config.KeyDirectory,
100 | 		}),
101 | 	} // Set fairyMQ global pointer
102 | 
103 | 	generateQueueKeyPairs := fairyMQ.Config.GenerateQueueKeyPairs
104 | 
105 | 	// If queue provided generate a new keypair
106 | 	if len(generateQueueKeyPairs) > 0 {
107 | 		for _, queue := range generateQueueKeyPairs {
108 | 			err := fairyMQ.PrivateKeys.GenerateQueueKeypair(queue)
109 | 			if err != nil {
110 | 				log.Println(err.Error())
111 | 				os.Exit(1)
112 | 			}
113 | 			log.Printf("Successfully generated key: %s", queue)
114 | 		}
115 | 	}
116 | 
117 | 	var err error
118 | 	fairyMQ.MemberlistShutdownFunc, err = fairyMQ.SetupMemberListCluster()
119 | 	if err != nil {
120 | 		log.Println(err.Error())
121 | 		os.Exit(1)
122 | 	}
123 | 
124 | 	fairyMQ.Context, fairyMQ.ContextCancel = context.WithCancel(context.Background()) // Set core context to cancel on signal
125 | 
126 | 	signal.Notify(fairyMQ.SignalChannel, syscall.SIGINT, syscall.SIGTERM, syscall.SIGKILL, syscall.SIGQUIT, syscall.SIGABRT) // Populate signal channel on signal
127 | 
128 | 	fairyMQ.Wg.Add(1)
129 | 	go fairyMQ.SignalListener() // Start signal listener
130 | 
131 | 	fairyMQ.Wg.Add(1)
132 | 	go fairyMQ.StartUDPListener() // Start UDP listener on default port 5991
133 | 
134 | 	fairyMQ.Wg.Add(1)
135 | 	go fairyMQ.RemoveExpired() // Start remove expired process
136 | 
137 | 	fairyMQ.Wg.Add(1)
138 | 	go fairyMQ.SyncPrivateKeys() // Start process to periodically sync private keys from file system into memory
139 | 
140 | 	fairyMQ.RecoverQueues() // Recover persisted queues
141 | 
142 | 	fairyMQ.Wg.Wait() // Wait for all go routines
143 | }
144 | 
145 | func (fairyMQ *FairyMQ) SyncPrivateKeys() {
146 | 	defer fairyMQ.Wg.Done()
147 | 
148 | 	for {
149 | 		if fairyMQ.Context.Err() != nil { // If signaled to shut down
150 | 			break
151 | 		}
152 | 		if err := fairyMQ.PrivateKeys.LoadKeys(); err != nil {
153 | 			log.Println(err)
154 | 		}
155 | 		<-time.After(fairyMQ.Config.keySyncInterval)
156 | 	}
157 | }
158 | 
159 | // SignalListener listens for system signals and gracefully shuts down
160 | func (fairyMQ *FairyMQ) SignalListener() {
161 | 	defer fairyMQ.Wg.Done()
162 | 	for {
163 | 		select {
164 | 		case sig := <-fairyMQ.SignalChannel:
165 | 			log.Println("received", sig)
166 | 			fairyMQ.ContextCancel()
167 | 			if fairyMQ.Conn != nil {
168 | 				if err := fairyMQ.Conn.Close(); err != nil {
169 | 					log.Println(err)
170 | 				}
171 | 			}
172 | 
173 | 			fairyMQ.Snapshot()
174 | 			if err := fairyMQ.MemberlistShutdownFunc(); err != nil {
175 | 				log.Println(err)
176 | 			}
177 | 			return
178 | 		default:
179 | 			time.Sleep(time.Nanosecond * 10000)
180 | 			continue
181 | 		}
182 | 	}
183 | }
184 | 
185 | // RemoveExpired removes expired messages from queue if queue is configured to do so.
186 | func (fairyMQ *FairyMQ) RemoveExpired() {
187 | 	defer fairyMQ.Wg.Done()
188 | 
189 | 	for {
190 | 		if fairyMQ.Context.Err() != nil { // if signaled to shut down
191 | 			break
192 | 		}
193 | 
194 | 		for j, q := range fairyMQ.Queues { // Loop over queues
195 | 			if q.ExpireMessages { // Check if queue is configured to expire messages
196 | 				for i := len(q.Messages) - 1; i >= 0; i-- { // Start from latest message
197 | 					if q.Messages[i].Timestamp.Before(q.Messages[i].Timestamp.Add(time.Duration(q.ExpiryTime))) {
198 | 						fairyMQ.QueueMutexes[j].Lock()
199 | 						fairyMQ.Queues[j].Messages = fairyMQ.Queues[j].Messages[0:i] // Remove older than current
200 | 						fairyMQ.QueueMutexes[j].Unlock()
201 | 					}
202 | 				}
203 | 			}
204 | 		}
205 | 		time.Sleep(time.Second * 2) // Every 2 seconds clean up expired from every queue
206 | 	}
207 | }
208 | 
209 | // SendToConsumers sends message to consumers of a queue
210 | func (fairyMQ *FairyMQ) SendToConsumers(queue string, data []byte, message *Message) {
211 | 	for _, c := range fairyMQ.Consumers {
212 | 		if c.Queue == queue {
213 | 			attempts := 0 // Max attempts to reach server is 10
214 | 
215 | 			// Resolve UDP address
216 | 			udpAddr, err := net.ResolveUDPAddr("udp", c.Address)
217 | 			if err != nil {
218 | 				continue
219 | 			}
220 | 
221 | 			// Dial address
222 | 			conn, err := net.DialUDP("udp", nil, udpAddr)
223 | 			if err != nil {
224 | 				continue
225 | 			}
226 | 
227 | 			publicKeyPEM, err := os.ReadFile(fmt.Sprintf("keys/%s.public.pem", queue))
228 | 			if err != nil {
229 | 				continue
230 | 			}
231 | 
232 | 			publicKeyBlock, _ := pem.Decode(publicKeyPEM)
233 | 			publicKey, err := x509.ParsePKIXPublicKey(publicKeyBlock.Bytes)
234 | 			if err != nil {
235 | 				continue
236 | 			}
237 | 
238 | 			ciphertext, err := rsa.EncryptPKCS1v15(rand.Reader, publicKey.(*rsa.PublicKey), data)
239 | 			if err != nil {
240 | 				continue
241 | 			}
242 | 
243 | 			// Attempt consumer
244 | 			goto try
245 | 
246 | 		try:
247 | 
248 | 			// Send to server
249 | 			_, err = conn.Write(ciphertext)
250 | 			if err != nil {
251 | 				continue
252 | 			}
253 | 
254 | 			// If nothing received in 60 milliseconds.  Retry
255 | 			err = conn.SetReadDeadline(time.Now().Add(60 * time.Millisecond))
256 | 			if err != nil {
257 | 				continue
258 | 			}
259 | 
260 | 			// Read from consumer
261 | 			res, err := bufio.NewReader(conn).ReadString('\n')
262 | 			if err != nil {
263 | 				if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
264 | 					attempts += 1
265 | 
266 | 					if attempts < 10 {
267 | 						goto try
268 | 					} else {
269 | 						continue
270 | 					}
271 | 				} else {
272 | 					continue
273 | 				}
274 | 			}
275 | 
276 | 			if strings.HasPrefix(res, "ACK") {
277 | 				message.AcknowledgedConsumers = append(message.AcknowledgedConsumers, c)
278 | 			}
279 | 		}
280 | 	}
281 | }
282 | 
283 | // RecoverQueues recovers queues from latest snapshot
284 | func (fairyMQ *FairyMQ) RecoverQueues() {
285 | 	if _, err := os.Stat("snapshots"); os.IsNotExist(err) {
286 | 		return
287 | 	}
288 | 
289 | 	snapshots, err := os.ReadDir("snapshots")
290 | 	if err != nil {
291 | 		log.Println("ERROR: ", err.Error())
292 | 		fairyMQ.SignalChannel <- os.Interrupt
293 | 		return
294 | 	}
295 | 
296 | 	sort.Slice(snapshots, func(i, j int) bool {
297 | 		fileI, err := snapshots[i].Info()
298 | 		if err != nil {
299 | 			return false
300 | 		}
301 | 		fileJ, err := snapshots[j].Info()
302 | 		if err != nil {
303 | 			return false
304 | 		}
305 | 		return fileI.ModTime().After(fileJ.ModTime())
306 | 	})
307 | 
308 | 	for _, snapshot := range snapshots {
309 | 		snapshotFile, err := os.Open(fmt.Sprintf("snapshots/%s", snapshot.Name()))
310 | 		if err != nil {
311 | 			log.Println("ERROR: ", err.Error())
312 | 			fairyMQ.SignalChannel <- os.Interrupt
313 | 			return
314 | 		}
315 | 		dataDecoder := gob.NewDecoder(snapshotFile)
316 | 		err = dataDecoder.Decode(&fairyMQ.Queues)
317 | 		if err != nil {
318 | 			log.Println("ERROR: ", err.Error())
319 | 			fairyMQ.SignalChannel <- os.Interrupt
320 | 			return
321 | 		}
322 | 
323 | 		for k := range fairyMQ.Queues {
324 | 			fairyMQ.QueueMutexes[k] = &sync.Mutex{}
325 | 		}
326 | 
327 | 		log.Println("Recovered from snapshot")
328 | 		break
329 | 	}
330 | }
331 | 
332 | // Snapshot takes a snapshot of current queue
333 | func (fairyMQ *FairyMQ) Snapshot() {
334 | 	if _, err := os.Stat("snapshots"); os.IsNotExist(err) {
335 | 		err := os.Mkdir("snapshots", 0777)
336 | 		if err != nil {
337 | 			log.Println("ERROR:", err.Error())
338 | 			return
339 | 		}
340 | 	}
341 | 
342 | 	snapshot, err := os.Create(fmt.Sprintf("snapshots/queue.%d.snapshot", time.Now().Unix()))
343 | 	if err != nil {
344 | 		log.Println("ERROR:", err.Error())
345 | 		return
346 | 	}
347 | 
348 | 	// serialize the data
349 | 	dataEncoder := gob.NewEncoder(snapshot)
350 | 
351 | 	err = dataEncoder.Encode(fairyMQ.Queues)
352 | 	if err != nil {
353 | 		log.Println(err.Error())
354 | 		return
355 | 	}
356 | }
357 | 
358 | // StartUDPListener starts listening and handling UDP connections
359 | func (fairyMQ *FairyMQ) StartUDPListener() {
360 | 	defer fairyMQ.Wg.Done()
361 | 	var err error
362 | 
363 | 	fairyMQ.UDPAddr, err = net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", fairyMQ.Config.BindAddress, fairyMQ.Config.BindPort))
364 | 	if err != nil {
365 | 		log.Println("ERROR: ", err.Error())
366 | 		fairyMQ.SignalChannel <- os.Interrupt
367 | 		return
368 | 	}
369 | 
370 | 	// Start listening for UDP packages on the given address
371 | 	fairyMQ.Conn, err = net.ListenUDP("udp", fairyMQ.UDPAddr)
372 | 	if err != nil {
373 | 		log.Println("ERROR: ", err.Error())
374 | 		fairyMQ.SignalChannel <- os.Interrupt
375 | 		return
376 | 	}
377 | 
378 | 	for {
379 | 		fairyMQ.Conn.SetReadDeadline(time.Now().Add(time.Nanosecond * 10000)) // essentially keep listening until the client closes connection or cluster shuts down
380 | 
381 | 		var buf [5120]byte
382 | 
383 | 		n, addr, err := fairyMQ.Conn.ReadFromUDP(buf[0:])
384 | 		if err != nil {
385 | 			if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
386 | 				if fairyMQ.Context.Err() != nil { // if signaled to shut down
387 | 					break
388 | 				}
389 | 				continue
390 | 			} else {
391 | 				break
392 | 			}
393 | 		}
394 | 
395 | 		go func() {
396 | 			queue, plaintext, err := fairyMQ.PrivateKeys.DecryptMessage(buf[0:n])
397 | 			if err != nil {
398 | 				fairyMQ.Conn.WriteToUDP([]byte("NACK\r\n"), addr)
399 | 			}
400 | 
401 | 			_, ok := fairyMQ.Queues[queue]
402 | 			if !ok {
403 | 				fairyMQ.Queues[queue] = &Queue{
404 | 					ExpireMessages: false,
405 | 					ExpiryTime:     7200,
406 | 					Messages:       []Message{},
407 | 					Consumers:      []string{},
408 | 				}
409 | 				_, ok = fairyMQ.QueueMutexes[queue]
410 | 				if !ok {
411 | 					fairyMQ.QueueMutexes[queue] = &sync.Mutex{}
412 | 				}
413 | 			}
414 | 
415 | 			switch {
416 | 			case bytes.HasPrefix(plaintext, []byte("MSGS WITH KEY ")):
417 | 				spl := bytes.Split(plaintext, []byte("MSGS WITH KEY "))
418 | 
419 | 				if len(spl) < 2 {
420 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
421 | 					return
422 | 				}
423 | 
424 | 				var messages [][]byte
425 | 
426 | 				// Will implement faster search
427 | 				for _, m := range fairyMQ.Queues[queue].Messages {
428 | 					if m.Key == string(spl[1]) {
429 | 						messages = append(messages, m.Data)
430 | 					}
431 | 				}
432 | 
433 | 				fairyMQ.Conn.WriteToUDP(append(bytes.Join(messages, []byte("\r\r")), []byte("\r\n")...), addr)
434 | 
435 | 			case bytes.HasPrefix(plaintext, []byte("EXP MSGS ")):
436 | 				spl := bytes.Split(plaintext, []byte("EXP MSGS "))
437 | 
438 | 				if len(spl) < 2 {
439 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
440 | 					return
441 | 				}
442 | 
443 | 				boolI, err := strconv.Atoi(string(spl[1]))
444 | 				if err != nil {
445 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
446 | 					return
447 | 				}
448 | 
449 | 				if boolI > 0 {
450 | 					fairyMQ.Queues[queue].ExpireMessages = true
451 | 				} else {
452 | 					fairyMQ.Queues[queue].ExpireMessages = false
453 | 				}
454 | 
455 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
456 | 
457 | 			case bytes.HasPrefix(plaintext, []byte("EXP MSGS SEC ")):
458 | 				spl := bytes.Split(plaintext, []byte("EXP MSGS SEC "))
459 | 
460 | 				if len(spl) < 2 {
461 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
462 | 					return
463 | 				}
464 | 
465 | 				seconds, err := strconv.Atoi(string(spl[1]))
466 | 				if err != nil {
467 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
468 | 					return
469 | 				}
470 | 
471 | 				fairyMQ.Queues[queue].ExpiryTime = uint(seconds)
472 | 
473 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
474 | 
475 | 			case bytes.HasPrefix(plaintext, []byte("FIRST IN")):
476 | 				fairyMQ.Conn.WriteToUDP(append(fairyMQ.Queues[queue].Messages[0].Data, []byte("\r\n")...), addr)
477 | 				return
478 | 			case bytes.HasPrefix(plaintext, []byte("LAST IN")):
479 | 				fairyMQ.Conn.WriteToUDP(append(fairyMQ.Queues[queue].Messages[len(fairyMQ.Queues[string(queue)].Messages)-1].Data, []byte("\r\n")...), addr)
480 | 				return
481 | 			case bytes.HasPrefix(plaintext, []byte("LENGTH")):
482 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("%d messages", len(fairyMQ.Queues[string(queue)].Messages))), []byte("\r\n")...), addr)
483 | 				return
484 | 			case bytes.HasPrefix(plaintext, []byte("POP")):
485 | 				if len(fairyMQ.Queues[queue].Messages) > 1 {
486 | 					fairyMQ.QueueMutexes[queue].Lock()
487 | 					fairyMQ.Queues[queue].Messages = fairyMQ.Queues[queue].Messages[:len(fairyMQ.Queues[string(queue)].Messages)-1]
488 | 					fairyMQ.QueueMutexes[queue].Unlock()
489 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
490 | 				} else {
491 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
492 | 				}
493 | 				return
494 | 			case bytes.HasPrefix(plaintext, []byte("SHIFT")):
495 | 				if len(fairyMQ.Queues[queue].Messages) > 1 {
496 | 					fairyMQ.QueueMutexes[queue].Lock()
497 | 					fairyMQ.Queues[queue].Messages = fairyMQ.Queues[queue].Messages[1:]
498 | 					fairyMQ.QueueMutexes[queue].Unlock()
499 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
500 | 				} else {
501 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
502 | 				}
503 | 				return
504 | 			case bytes.HasPrefix(plaintext, []byte("CLEAR")):
505 | 				if len(fairyMQ.Queues[queue].Messages) > 0 {
506 | 					fairyMQ.QueueMutexes[queue].Lock()
507 | 					delete(fairyMQ.Queues, queue)
508 | 					fairyMQ.QueueMutexes[queue].Unlock()
509 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
510 | 				} else {
511 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
512 | 				}
513 | 				return
514 | 			case bytes.HasPrefix(plaintext, []byte("NEW CONSUMER ")):
515 | 				spl := bytes.Split(plaintext, []byte("NEW CONSUMER "))
516 | 
517 | 				for _, c := range fairyMQ.Consumers {
518 | 					if c.Queue == queue {
519 | 						if c.Address == strings.TrimSpace(string(spl[1])) {
520 | 							fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
521 | 							continue
522 | 						}
523 | 					}
524 | 				}
525 | 
526 | 				fairyMQ.Consumers = append(fairyMQ.Consumers, Consumer{
527 | 					Queue:   queue,
528 | 					Address: strings.TrimSpace(string(spl[1])),
529 | 				})
530 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
531 | 				return
532 | 			case bytes.HasPrefix(plaintext, []byte("REM CONSUMER ")):
533 | 				spl := bytes.Split(plaintext, []byte("REM CONSUMER "))
534 | 				fairyMQ.Consumers = append(fairyMQ.Consumers, Consumer{
535 | 					Queue:   queue,
536 | 					Address: strings.TrimSpace(string(spl[1])),
537 | 				})
538 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("ACK")), []byte("\r\n")...), addr)
539 | 				return
540 | 			case bytes.HasPrefix(plaintext, []byte("LIST CONSUMERS")):
541 | 				var consumers []string
542 | 
543 | 				for _, c := range fairyMQ.Consumers {
544 | 					if c.Queue == queue {
545 | 						consumers = append(consumers, c.Address)
546 | 					}
547 | 				}
548 | 
549 | 				fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf(strings.Join(consumers, ","))), []byte("\r\n")...), addr)
550 | 				return
551 | 			case bytes.HasPrefix(plaintext, []byte("ENQUEUE")) || bytes.HasPrefix(plaintext, []byte("ENQUEUE ")):
552 | 				messageKey := "" // usually empty unless provided
553 | 
554 | 				if bytes.HasPrefix(plaintext, []byte("ENQUEUE ")) { // has key
555 | 					spl := bytes.Split(plaintext, []byte("ENQUEUE "))
556 | 					messageKey = string(bytes.Split(spl[1], []byte("\r\n"))[0]) // They are not unique
557 | 				}
558 | 
559 | 				spl := bytes.Split(plaintext, []byte("\r\n"))
560 | 				timestamp, err := strconv.ParseInt(string(spl[1]), 10, 64)
561 | 				if err != nil {
562 | 					fairyMQ.Conn.WriteToUDP(append([]byte(fmt.Sprintf("NACK")), []byte("\r\n")...), addr)
563 | 					return
564 | 				}
565 | 
566 | 				message := Message{
567 | 					Data:      spl[2],
568 | 					Key:       messageKey,
569 | 					Timestamp: time.UnixMicro(timestamp),
570 | 				}
571 | 
572 | 				go fairyMQ.SendToConsumers(queue, plaintext, &message)
573 | 				fairyMQ.QueueMutexes[queue].Lock()
574 | 				fairyMQ.Queues[queue].Messages = append(fairyMQ.Queues[queue].Messages, message)
575 | 				sort.Slice(fairyMQ.Queues[queue].Messages, func(i, j int) bool {
576 | 					return fairyMQ.Queues[queue].Messages[i].Timestamp.After(fairyMQ.Queues[queue].Messages[j].Timestamp)
577 | 				})
578 | 				fairyMQ.QueueMutexes[queue].Unlock()
579 | 
580 | 				fairyMQ.Conn.WriteToUDP([]byte("ACK\r\n"), addr)
581 | 				return
582 | 			default:
583 | 				fairyMQ.Conn.WriteToUDP([]byte("NACK\r\n"), addr)
584 | 			}
585 | 		}()
586 | 	}
587 | }
588 | 


--------------------------------------------------------------------------------
/main_test.go:
--------------------------------------------------------------------------------
  1 | /*
  2 | * fairyMQ
  3 | * Core Unit Tests
  4 | * ******************************************************************
  5 | * Originally authored by Alex Gaetano Padula
  6 | * Copyright (C) fairyMQ
  7 | *
  8 | * This program is free software: you can redistribute it and/or modify
  9 | * it under the terms of the GNU General Public License as published by
 10 | * the Free Software Foundation, either version 3 of the License, or
 11 | * (at your option) any later version.
 12 | *
 13 | * This program is distributed in the hope that it will be useful,
 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16 | * GNU General Public License for more details.
 17 | *
 18 | * You should have received a copy of the GNU General Public License
 19 | * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 20 |  */
 21 | package main
 22 | 
 23 | import (
 24 | 	"bufio"
 25 | 	"context"
 26 | 	"crypto/rsa"
 27 | 	keys "fairymq/queue-keys"
 28 | 	"fmt"
 29 | 	"net"
 30 | 	"os"
 31 | 	"strings"
 32 | 	"sync"
 33 | 	"testing"
 34 | )
 35 | 
 36 | type MockPrivateKeyContainer struct {
 37 | }
 38 | 
 39 | func (mpk MockPrivateKeyContainer) GenerateQueueKeypair(queue string) error {
 40 | 	return nil
 41 | }
 42 | func (mpk MockPrivateKeyContainer) Add(queue string, key *rsa.PrivateKey) {}
 43 | func (mpk MockPrivateKeyContainer) LoadKeys() error {
 44 | 	return nil
 45 | }
 46 | func (mpk MockPrivateKeyContainer) DecryptMessage(buf []byte) (string, []byte, error) {
 47 | 	return "test-queue", []byte("message"), nil
 48 | }
 49 | 
 50 | func TestFairyMQ_SignalListener(t *testing.T) {
 51 | 	type fields struct {
 52 | 		UDPAddr                *net.UDPAddr
 53 | 		Conn                   *net.UDPConn
 54 | 		Wg                     *sync.WaitGroup
 55 | 		SignalChannel          chan os.Signal
 56 | 		Queues                 map[string]*Queue
 57 | 		QueueMutexes           map[string]*sync.Mutex
 58 | 		ContextCancel          context.CancelFunc
 59 | 		Context                context.Context
 60 | 		Config                 Config
 61 | 		MemberlistShutdownFunc func() error
 62 | 		PrivateKeys            keys.PrivateKeyContainer
 63 | 	}
 64 | 	tests := []struct {
 65 | 		name    string
 66 | 		fields  fields
 67 | 		want    []byte
 68 | 		wantErr bool
 69 | 	}{
 70 | 		{
 71 | 			name:    "test",
 72 | 			wantErr: false,
 73 | 			fields: fields{
 74 | 				Wg:                     &sync.WaitGroup{},
 75 | 				SignalChannel:          make(chan os.Signal),
 76 | 				MemberlistShutdownFunc: func() error { return nil },
 77 | 				Queues:                 make(map[string]*Queue),
 78 | 				QueueMutexes:           make(map[string]*sync.Mutex),
 79 | 				Config: Config{
 80 | 					BindAddress: "0.0.0.0",
 81 | 					BindPort:    5991,
 82 | 				},
 83 | 				PrivateKeys: MockPrivateKeyContainer{},
 84 | 			},
 85 | 		},
 86 | 	}
 87 | 	for _, tt := range tests {
 88 | 		var err error
 89 | 		t.Run(tt.name, func(t *testing.T) {
 90 | 			fairyMQ := &FairyMQ{
 91 | 				UDPAddr:                tt.fields.UDPAddr,
 92 | 				Conn:                   tt.fields.Conn,
 93 | 				Wg:                     tt.fields.Wg,
 94 | 				SignalChannel:          tt.fields.SignalChannel,
 95 | 				Queues:                 tt.fields.Queues,
 96 | 				QueueMutexes:           tt.fields.QueueMutexes,
 97 | 				ContextCancel:          tt.fields.ContextCancel,
 98 | 				Context:                tt.fields.Context,
 99 | 				Config:                 tt.fields.Config,
100 | 				MemberlistShutdownFunc: tt.fields.MemberlistShutdownFunc,
101 | 			}
102 | 
103 | 			fairyMQ.UDPAddr, err = net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", fairyMQ.Config.BindAddress, fairyMQ.Config.BindPort))
104 | 			if err != nil {
105 | 				t.Errorf("TestFairyMQ_SignalListener() error = %v", err)
106 | 			}
107 | 
108 | 			// Start listening for UDP packages on the given address
109 | 			fairyMQ.Conn, err = net.ListenUDP("udp", fairyMQ.UDPAddr)
110 | 			if err != nil {
111 | 				t.Errorf("TestFairyMQ_SignalListener() error = %v", err)
112 | 			}
113 | 
114 | 			fairyMQ.Context, fairyMQ.ContextCancel = context.WithCancel(context.Background())
115 | 
116 | 			fairyMQ.Wg.Add(1)
117 | 			go fairyMQ.SignalListener()
118 | 
119 | 			fairyMQ.Wg.Add(1)
120 | 			go func() {
121 | 				defer fairyMQ.Wg.Done()
122 | 				tt.fields.SignalChannel <- os.Interrupt
123 | 			}()
124 | 
125 | 			fairyMQ.Wg.Wait()
126 | 		})
127 | 	}
128 | }
129 | 
130 | func TestFairyMQ_StartUDPListener(t *testing.T) {
131 | 	type fields struct {
132 | 		UDPAddr                *net.UDPAddr
133 | 		Conn                   *net.UDPConn
134 | 		Wg                     *sync.WaitGroup
135 | 		SignalChannel          chan os.Signal
136 | 		Queues                 map[string]*Queue
137 | 		QueueMutexes           map[string]*sync.Mutex
138 | 		ContextCancel          context.CancelFunc
139 | 		Context                context.Context
140 | 		Config                 Config
141 | 		MemberlistShutdownFunc func() error
142 | 		PrivateKeys            keys.PrivateKeyContainer
143 | 	}
144 | 	tests := []struct {
145 | 		name    string
146 | 		fields  fields
147 | 		want    []byte
148 | 		wantErr bool
149 | 	}{
150 | 		{
151 | 			name:    "test",
152 | 			wantErr: false,
153 | 			fields: fields{
154 | 				Wg:            &sync.WaitGroup{},
155 | 				SignalChannel: make(chan os.Signal),
156 | 				Queues:        make(map[string]*Queue),
157 | 				QueueMutexes:  make(map[string]*sync.Mutex),
158 | 				Config: Config{
159 | 					BindAddress: "0.0.0.0",
160 | 					BindPort:    5991,
161 | 				},
162 | 				MemberlistShutdownFunc: func() error { return nil },
163 | 				PrivateKeys:            MockPrivateKeyContainer{},
164 | 			},
165 | 		},
166 | 	}
167 | 	for _, tt := range tests {
168 | 		t.Run(tt.name, func(t *testing.T) {
169 | 			fairyMQ := &FairyMQ{
170 | 				UDPAddr:                tt.fields.UDPAddr,
171 | 				Conn:                   tt.fields.Conn,
172 | 				Wg:                     tt.fields.Wg,
173 | 				SignalChannel:          tt.fields.SignalChannel,
174 | 				Queues:                 tt.fields.Queues,
175 | 				QueueMutexes:           tt.fields.QueueMutexes,
176 | 				ContextCancel:          tt.fields.ContextCancel,
177 | 				Context:                tt.fields.Context,
178 | 				Config:                 tt.fields.Config,
179 | 				MemberlistShutdownFunc: tt.fields.MemberlistShutdownFunc,
180 | 				PrivateKeys:            tt.fields.PrivateKeys,
181 | 			}
182 | 
183 | 			fairyMQ.Wg.Add(1)
184 | 			go fairyMQ.StartUDPListener()
185 | 
186 | 			fairyMQ.Context, fairyMQ.ContextCancel = context.WithCancel(context.Background())
187 | 
188 | 			fairyMQ.Wg.Add(1)
189 | 			go func() {
190 | 				defer fairyMQ.Wg.Done()
191 | 				udpAddr, err := net.ResolveUDPAddr("udp", fmt.Sprintf("%s:%d", fairyMQ.Config.BindAddress, fairyMQ.Config.BindPort))
192 | 				if err != nil {
193 | 					t.Errorf("TestFairyMQ_StartUDPListener() error = %v", err)
194 | 				}
195 | 
196 | 				conn, err := net.DialUDP("udp", nil, udpAddr)
197 | 				if err != nil {
198 | 					t.Errorf("TestFairyMQ_StartUDPListener() error = %v", err)
199 | 				}
200 | 
201 | 				_, err = conn.Write([]byte("testing, 1, 2, 3\n"))
202 | 				if err != nil {
203 | 					t.Errorf("TestFairyMQ_StartUDPListener() error = %v", err)
204 | 				}
205 | 
206 | 				data, err := bufio.NewReader(conn).ReadString('\n')
207 | 				if err != nil {
208 | 					t.Errorf("TestFairyMQ_StartUDPListener() error = %v", err)
209 | 				}
210 | 
211 | 				if strings.HasPrefix(data, "NACK") {
212 | 					fairyMQ.ContextCancel()
213 | 				} else {
214 | 					t.Errorf("TestFairyMQ_StartUDPListener() error = incorrect response.  expecting NACK")
215 | 				}
216 | 			}()
217 | 
218 | 			fairyMQ.Wg.Wait()
219 | 		})
220 | 	}
221 | }
222 | 


--------------------------------------------------------------------------------
/memberlist.go:
--------------------------------------------------------------------------------
 1 | package main
 2 | 
 3 | import (
 4 | 	"fmt"
 5 | 	"github.com/hashicorp/memberlist"
 6 | 	"time"
 7 | )
 8 | 
 9 | func (fairyMQ *FairyMQ) SetupMemberListCluster() (func() error, error) {
10 | 	config := memberlist.DefaultWANConfig()
11 | 	config.Name = fmt.Sprintf("%s:%d", fairyMQ.Config.BindAddress, fairyMQ.Config.MemberlistPort)
12 | 	config.ProtocolVersion = memberlist.ProtocolVersionMax
13 | 	config.PushPullInterval = fairyMQ.Config.PushPullInterval
14 | 	config.BindAddr = fairyMQ.Config.BindAddress
15 | 	config.BindPort = int(fairyMQ.Config.MemberlistPort)
16 | 	config.AdvertisePort = int(fairyMQ.Config.MemberlistPort)
17 | 	config.EnableCompression = true
18 | 	config.Delegate = &Delegate{
19 | 		fairyMQ: fairyMQ,
20 | 	}
21 | 
22 | 	list, err := memberlist.Create(config)
23 | 
24 | 	if err != nil {
25 | 		return nil, err
26 | 	}
27 | 
28 | 	if len(fairyMQ.Config.JoinAddresses) > 0 {
29 | 		_, err = list.Join(fairyMQ.Config.JoinAddresses)
30 | 		if err != nil {
31 | 			return nil, err
32 | 		}
33 | 	}
34 | 
35 | 	shutdownFunc := func() error {
36 | 		if err := list.Leave(200 * time.Millisecond); err != nil {
37 | 			return fmt.Errorf("memberlist shutdown - leave: %+v", err)
38 | 		}
39 | 		if err = list.Shutdown(); err != nil {
40 | 			return fmt.Errorf("memberlist shutdown - shutdown: %+v", err)
41 | 		}
42 | 		return nil
43 | 	}
44 | 
45 | 	return shutdownFunc, nil
46 | }
47 | 


--------------------------------------------------------------------------------
/queue-keys/queue_keys.go:
--------------------------------------------------------------------------------
  1 | package queue_keys
  2 | 
  3 | import (
  4 | 	"crypto/rand"
  5 | 	"crypto/rsa"
  6 | 	"crypto/x509"
  7 | 	"encoding/pem"
  8 | 	"fmt"
  9 | 	"os"
 10 | 	"path"
 11 | 	"strings"
 12 | 	"sync"
 13 | )
 14 | 
 15 | type PrivateKeyConfig struct {
 16 | 	KeyDirectory string
 17 | }
 18 | 
 19 | // PrivateKeyContainer is the interface required
 20 | type PrivateKeyContainer interface {
 21 | 	GenerateQueueKeypair(queue string) error
 22 | 	Add(queue string, key *rsa.PrivateKey)
 23 | 	LoadKeys() error
 24 | 	DecryptMessage(buf []byte) (string, []byte, error)
 25 | }
 26 | 
 27 | // DefaultPrivateKeyContainer is the default implementation for PrivateKeyContainer.
 28 | // It holds the keys used to decrypt queue messages.
 29 | type DefaultPrivateKeyContainer struct {
 30 | 	config PrivateKeyConfig
 31 | 	keys   map[string]*rsa.PrivateKey
 32 | 	mut    *sync.RWMutex
 33 | }
 34 | 
 35 | func NewDefaultPrivateKeyContainer(config PrivateKeyConfig) *DefaultPrivateKeyContainer {
 36 | 	return &DefaultPrivateKeyContainer{
 37 | 		config: config,
 38 | 		keys:   make(map[string]*rsa.PrivateKey),
 39 | 		mut:    &sync.RWMutex{},
 40 | 	}
 41 | }
 42 | 
 43 | // GenerateQueueKeypair creates a queue keypair
 44 | func (pk *DefaultPrivateKeyContainer) GenerateQueueKeypair(queue string) error {
 45 | 	if _, err := os.Stat(pk.config.KeyDirectory); err != nil {
 46 | 		if os.IsNotExist(err) {
 47 | 			err := os.MkdirAll(pk.config.KeyDirectory, 0777)
 48 | 			if err != nil {
 49 | 				return err
 50 | 			}
 51 | 		}
 52 | 	}
 53 | 
 54 | 	privateKey, err := rsa.GenerateKey(rand.Reader, 2048)
 55 | 	if err != nil {
 56 | 		return err
 57 | 	}
 58 | 
 59 | 	publicKey := &privateKey.PublicKey
 60 | 
 61 | 	privateKeyBytes := x509.MarshalPKCS1PrivateKey(privateKey)
 62 | 	privateKeyPEM := pem.EncodeToMemory(&pem.Block{
 63 | 		Type:  "RSA PRIVATE KEY",
 64 | 		Bytes: privateKeyBytes,
 65 | 	})
 66 | 
 67 | 	err = os.WriteFile(fmt.Sprintf("%s/%s.private.pem", pk.config.KeyDirectory, queue), privateKeyPEM, 0644)
 68 | 	if err != nil {
 69 | 		return err
 70 | 	}
 71 | 
 72 | 	publicKeyBytes, err := x509.MarshalPKIXPublicKey(publicKey)
 73 | 	if err != nil {
 74 | 		return err
 75 | 	}
 76 | 	publicKeyPEM := pem.EncodeToMemory(&pem.Block{
 77 | 		Type:  "RSA PUBLIC KEY",
 78 | 		Bytes: publicKeyBytes,
 79 | 	})
 80 | 	err = os.WriteFile(fmt.Sprintf("%s/%s.public.pem", pk.config.KeyDirectory, queue), publicKeyPEM, 0644)
 81 | 	if err != nil {
 82 | 		return err
 83 | 	}
 84 | 
 85 | 	pk.Add(queue, privateKey)
 86 | 
 87 | 	return nil
 88 | }
 89 | 
 90 | func (pk *DefaultPrivateKeyContainer) Add(queue string, key *rsa.PrivateKey) {
 91 | 	pk.mut.Lock()
 92 | 	defer pk.mut.Unlock()
 93 | 
 94 | 	for _, k := range pk.keys {
 95 | 		if k.Equal(key) {
 96 | 			return
 97 | 		}
 98 | 	}
 99 | 
100 | 	pk.keys[queue] = key
101 | }
102 | 
103 | func (pk *DefaultPrivateKeyContainer) LoadKeys() error {
104 | 	files, err := os.ReadDir(pk.config.KeyDirectory)
105 | 	if err != nil {
106 | 		return err
107 | 	}
108 | 
109 | 	for _, file := range files {
110 | 		if strings.HasSuffix(file.Name(), "private.pem") {
111 | 			privateKeyPEM, err := os.ReadFile(path.Join(pk.config.KeyDirectory, file.Name()))
112 | 			if err != nil {
113 | 				return err
114 | 			}
115 | 			privateKeyBlock, _ := pem.Decode(privateKeyPEM)
116 | 			privateKey, err := x509.ParsePKCS1PrivateKey(privateKeyBlock.Bytes)
117 | 			if err != nil {
118 | 				return err
119 | 			}
120 | 
121 | 			queue := file.Name()[:strings.Index(file.Name(), ".private.pem")]
122 | 			pk.Add(queue, privateKey)
123 | 		}
124 | 	}
125 | 
126 | 	pk.mut.RLock()
127 | 	defer pk.mut.RUnlock()
128 | 
129 | 	return nil
130 | }
131 | 
132 | func (pk *DefaultPrivateKeyContainer) DecryptMessage(buf []byte) (string, []byte, error) {
133 | 	var queue string
134 | 	var decrypted []byte
135 | 	var err error
136 | 
137 | 	pk.mut.RLock()
138 | 	defer pk.mut.RUnlock()
139 | 
140 | 	for q, key := range pk.keys {
141 | 		decrypted, err = rsa.DecryptPKCS1v15(rand.Reader, key, buf)
142 | 		if err == nil {
143 | 			queue = q
144 | 			break
145 | 		}
146 | 	}
147 | 
148 | 	return queue, decrypted, err
149 | }
150 | 


--------------------------------------------------------------------------------
/queue-keys/queue_keys_test.go:
--------------------------------------------------------------------------------
  1 | package queue_keys
  2 | 
  3 | import (
  4 | 	"bytes"
  5 | 	"crypto/rand"
  6 | 	"crypto/rsa"
  7 | 	"crypto/x509"
  8 | 	"encoding/pem"
  9 | 	"fmt"
 10 | 	"os"
 11 | 	"path"
 12 | 	"testing"
 13 | )
 14 | 
 15 | const (
 16 | 	KeyDirectory = "test/keys"
 17 | )
 18 | 
 19 | type Message struct {
 20 | 	Raw       []byte
 21 | 	Encrypted []byte
 22 | }
 23 | 
 24 | func TestDefaultPrivateKeyContainer(t *testing.T) {
 25 | 	pkc := NewDefaultPrivateKeyContainer(PrivateKeyConfig{
 26 | 		KeyDirectory: KeyDirectory,
 27 | 	})
 28 | 
 29 | 	// Generate the queue-key pairs and create the files
 30 | 	queues := []string{"test-queue-one", "test-queue-two", "test.queue.three"}
 31 | 	for _, queue := range queues {
 32 | 		if err := pkc.GenerateQueueKeypair(queue); err != nil {
 33 | 			t.Error(err)
 34 | 		}
 35 | 	}
 36 | 
 37 | 	// Load the keys
 38 | 	if err := pkc.LoadKeys(); err != nil {
 39 | 		t.Error(err)
 40 | 	}
 41 | 
 42 | 	// Check all the expected keys for all the queues have been loaded into memory
 43 | 	if len(pkc.keys) != len(queues) {
 44 | 		t.Errorf("number of keys loaded %d is not equal to length of key map %d", len(pkc.keys), len(queues))
 45 | 	}
 46 | 	for _, queue := range queues {
 47 | 		if _, ok := pkc.keys[queue]; !ok {
 48 | 			t.Errorf("key for queue %s not found in loaded key map", queue)
 49 | 		}
 50 | 	}
 51 | 
 52 | 	// Retrieve the public keys
 53 | 	publicKeys := make(map[string]*rsa.PublicKey)
 54 | 	for _, queue := range queues {
 55 | 		publicKeyPEM, err := os.ReadFile(path.Join(KeyDirectory, fmt.Sprintf("%s.public.pem", queue)))
 56 | 		if err != nil {
 57 | 			t.Error(err)
 58 | 		}
 59 | 		publicKeyBlock, _ := pem.Decode(publicKeyPEM)
 60 | 		publicKey, err := x509.ParsePKIXPublicKey(publicKeyBlock.Bytes)
 61 | 		if err != nil {
 62 | 			t.Error(err)
 63 | 		}
 64 | 		publicKeys[queue] = publicKey.(*rsa.PublicKey)
 65 | 	}
 66 | 
 67 | 	// Encrypt some messages with each public key
 68 | 	messages := make(map[string]Message)
 69 | 	for _, queue := range queues {
 70 | 		raw := []byte(fmt.Sprintf("Test message for queue %s", queue))
 71 | 		encrypted, err := rsa.EncryptPKCS1v15(rand.Reader, publicKeys[queue], raw)
 72 | 		if err != nil {
 73 | 			t.Error(err)
 74 | 		}
 75 | 		messages[queue] = Message{
 76 | 			Raw:       raw,
 77 | 			Encrypted: encrypted,
 78 | 		}
 79 | 	}
 80 | 
 81 | 	// Decrypt each of the messages encrypted in the previous step
 82 | 	for queue, message := range messages {
 83 | 		q, msg, err := pkc.DecryptMessage(message.Encrypted)
 84 | 		if err != nil {
 85 | 			t.Error(err)
 86 | 		}
 87 | 		if q != queue {
 88 | 			t.Errorf("wrong queue name %s, expected %s", q, queue)
 89 | 		}
 90 | 		if !bytes.Equal(msg, message.Raw) {
 91 | 			t.Error("decrypted message not equal to raw message")
 92 | 		}
 93 | 	}
 94 | 
 95 | 	// Clean up the key directory
 96 | 	if err := os.RemoveAll(KeyDirectory); err != nil {
 97 | 		t.Error(err)
 98 | 	}
 99 | }
100 | 


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
  1 | <center>
  2 |     <img src="./images/fairymq.png" width="200" />
  3 | </center>
  4 | fairyMQ is an open-source UDP based message queue software written in GO.  fairyMQ is in-memory, secure, extremely fast and super simple.
  5 | 
  6 | 
  7 | ### Features
  8 | 
  9 | ⭐ High throughput and low latency with reliable light weight UDP based protocol
 10 | 
 11 | ⭐ Transmission secure with asymmetric cryptography 
 12 | 
 13 | ⭐ Snapshots to disk
 14 | 
 15 | ⭐ Recovery latest snapshot from disk
 16 | 
 17 | ⭐ Messages marked with consumer(s) whom acknowledged
 18 | 
 19 | ⭐ Message Expiry (delete expired messages from queue)
 20 | 
 21 | ⭐ Multiple Queues
 22 | 
 23 | ⭐ Searching messages by key (Keys are not unique)
 24 | 
 25 | ⭐ Message data has no limit and are a buffer of bytes enqueued by a client
 26 | 
 27 | 
 28 | ## Setup
 29 | **************
 30 | fairyMQ expects a keypair per queue.  When sending messages to fairy the messages must be encrypted with the queues public key.
 31 | fairy will try all available keys to decrypt a message before failing.  Upon successful encryption fairy knows which queue to access.
 32 | 
 33 | ``` 
 34 | ./fairymq --generate-queue-key-pair example
 35 | ```
 36 | 
 37 | ## Native Clients
 38 | **************
 39 | - **GO** https://github.com/fairymq/fairymq-go
 40 | - **Node.JS** (coming soon)
 41 | - **Java** (coming soon)
 42 | - **Python** (coming soon)
 43 | - **C#** (coming soon)
 44 | 
 45 | ## Native Consumers
 46 | **************
 47 | - **GO** (coming soon)
 48 | - **Node.JS** https://github.com/fairymq/fairymq-consumer-nodejs
 49 | - **Java** (coming soon)
 50 | - **Python** (coming soon)
 51 | - **C#** (coming soon)
 52 | 
 53 | ## How to use
 54 | **************
 55 | To start download or build fairyMQ.
 56 | 
 57 | Once downloaded or built you can start fairyMQ but mind you fairy requires an initial keypair so we can generate that with flag ``--generate-queue-key-pair=YOURQUEUENAME``
 58 | ```
 59 | ./fairyMQ &
 60 | ```
 61 | Above runs fairy.
 62 | 
 63 | To generate a new queue keypair
 64 | ```
 65 | ./fairyMQ --generate-queue-key-pair=YOURQUEUENAME
 66 | ```
 67 | 
 68 | Above will allow enqueues with a public key into an in-memory queue.  There can be multiple.
 69 | 
 70 | ### Distribution
 71 | If you want to sync multiple nodes data you can use:
 72 | ```
 73 | --join-address
 74 | ```
 75 | Above is the IP address and memberlist port of a peer in a cluster we would like to join
 76 | 
 77 | Is the frequency in-which nodes synchronize
 78 | ```
 79 | --push-pull-interval
 80 | ```
 81 | 
 82 | Port used to communicate with other nodes
 83 | ```
 84 | memberlist-port
 85 | ```
 86 | 
 87 | 
 88 | fairyMQ is a *distributed* message queue meaning we can start 1 or many external nodes.  These nodes sync all queues.
 89 | 
 90 | ## Building
 91 | ***************
 92 | Building
 93 | VERSION to be replaced with V for example v1.0.1 or use ``bundle.sh`` to build all platform binaries
 94 | 
 95 | **Darwin / MacOS**
 96 | ****
 97 | ```
 98 | env GOOS=darwin GOARCH=amd64 go build -o bin/macos-darwin/amd64/fairymq && tar -czf bin/macos-darwin/amd64/fairymq-VERSION-amd64.tar.gz -C bin/macos-darwin/amd64/ $(ls  bin/macos-darwin/amd64/)
 99 | ```
100 | 
101 | ```
102 | env GOOS=darwin GOARCH=arm64 go build -o bin/macos-darwin/arm64/fairymq && tar -czf bin/macos-darwin/arm64/fairymq-VERSION-arm64.tar.gz -C bin/macos-darwin/arm64/ $(ls  bin/macos-darwin/arm64/)
103 | ```
104 | 
105 | 
106 | **Linux**
107 | ****
108 | ```
109 | env GOOS=linux GOARCH=386 go build -o bin/linux/386/fairymq && tar -czf bin/linux/386/fairymq-VERSION-386.tar.gz -C bin/linux/386/ $(ls  bin/linux/386/)
110 | ```
111 | 
112 | ```
113 | env GOOS=linux GOARCH=amd64 go build -o bin/linux/amd64/fairymq && tar -czf bin/linux/amd64/fairymq-VERSION-amd64.tar.gz -C bin/linux/amd64/ $(ls  bin/linux/amd64/)
114 | ```
115 | 
116 | ```
117 | env GOOS=linux GOARCH=arm go build -o bin/linux/arm/fairymq && tar -czf bin/linux/arm/fairymq-VERSION-arm.tar.gz -C bin/linux/arm/ $(ls  bin/linux/arm/)
118 | ```
119 | 
120 | ```
121 | env GOOS=linux GOARCH=arm64 go build -o bin/linux/arm64/fairymq && tar -czf bin/linux/arm64/fairymq-VERSION-arm64.tar.gz -C bin/linux/arm64/ $(ls  bin/linux/arm64/)
122 | ```
123 | 
124 | 
125 | **FreeBSD**
126 | ****
127 | ```
128 | env GOOS=freebsd GOARCH=arm go build -o bin/freebsd/arm/fairymq && tar -czf bin/freebsd/arm/fairymq-VERSION-arm.tar.gz -C bin/freebsd/arm/ $(ls  bin/freebsd/arm/)
129 | ```
130 | 
131 | ```
132 | env GOOS=freebsd GOARCH=amd64 go build -o bin/freebsd/amd64/fairymq && tar -czf bin/freebsd/amd64/fairymq-VERSION-amd64.tar.gz -C bin/freebsd/amd64/ $(ls  bin/freebsd/amd64/)
133 | ```
134 | 
135 | ```
136 | env GOOS=freebsd GOARCH=386 go build -o bin/freebsd/386/fairymq && tar -czf bin/freebsd/386/fairymq-VERSION-386.tar.gz -C bin/freebsd/386/ $(ls  bin/freebsd/386/)
137 | ```
138 | 
139 | 
140 | **Windows**
141 | ****
142 | ```
143 | env GOOS=windows GOARCH=amd64 go build -o bin/windows/amd64/fairymq.exe && zip -r -j bin/windows/amd64/fairymq-VERSION-x64.zip bin/windows/amd64/fairymq.exe
144 | ```
145 | 
146 | ```
147 | env GOOS=windows GOARCH=arm64 go build -o bin/windows/arm64/fairymq.exe && zip -r -j bin/windows/arm64/fairymq-VERSION-x64.zip bin/windows/arm64/fairymq.exe
148 | ```
149 | 
150 | ```
151 | env GOOS=windows GOARCH=386 go build -o bin/windows/386/fairymq.exe && zip -r -j bin/windows/386/fairymq-VERSION-x86.zip bin/windows/386/fairymq.exe
152 | ```
153 | 
154 | 
155 | ## Protocol & Language
156 | ***************
157 | 
158 | - **fairyMQ port is 5991**
159 | 
160 | - **fairyMQ consumer port is 5992 by default but can be changed.**
161 | 
162 | #### New message
163 | ``` 
164 | ENQUEUE\r\n
165 | timestamp\r\n
166 | ..bytes
167 | ```
168 | 
169 | With key
170 | ``` 
171 | ENQUEUE somerandomkey\r\n
172 | timestamp\r\n
173 | ..bytes
174 | ```
175 | 
176 | #### First message in queue
177 | ``` 
178 | FIRST IN
179 | ```
180 | 
181 | #### Last message in queue
182 | ``` 
183 | LAST IN
184 | ```
185 | 
186 | #### Length of queue
187 | ``` 
188 | LENGTH
189 | ```
190 | 
191 | #### Remove last message
192 | ``` 
193 | POP
194 | ```
195 | 
196 | #### Remove first message
197 | ``` 
198 | SHIFT
199 | ```
200 | 
201 | #### Remove/Clear queue
202 | ``` 
203 | CLEAR
204 | ```
205 | 
206 | #### New Consumer
207 | ``` 
208 | NEW CONSUMER 0.0.0.0:5992
209 | ```
210 | HOST:PORT
211 | 
212 | #### Remove Consumer
213 | ``` 
214 | REM CONSUMER 0.0.0.0:5992
215 | ```
216 | HOST:PORT
217 | 
218 | #### List Consumers
219 | ``` 
220 | LIST CONSUMERS
221 | ```
222 | 
223 | #### EXPIRE MESSAGES
224 | 
225 | Set true
226 | ``` 
227 | EXP MSGS 1
228 | ```
229 | 
230 | Set false
231 | ``` 
232 | EXP MSGS 0
233 | ```
234 | 
235 | #### EXPIRE MESSAGES SECONDS
236 | 
237 | Setting to 4 hours in seconds
238 | ``` 
239 | EXP MSGS SEC 14400
240 | ```
241 | 
242 | #### GET MESSAGES WITH CERTAIN KEY
243 | ``` 
244 | MSGS WITH KEY banana
245 | ```
246 | Returns bytes with each item split with ``\r\r``
247 | 
248 | i.e
249 | ``` 
250 | [12 32 45 232]\r\r
251 | [2 3 77 232]\r\r
252 | [12 32]\r\n
253 | ```


--------------------------------------------------------------------------------