├── .github └── FUNDING.yml ├── go.mod ├── go.sum ├── README.md ├── mispfeedgenerator_test.go ├── util.go ├── mispfeedgenerator.go ├── model.go └── LICENSE /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: kaansk 4 | ko_fi: kaansk 5 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/KaanSK/Go-MISPFeedGenerator 2 | 3 | go 1.15 4 | 5 | require ( 6 | github.com/google/uuid v1.2.0 7 | github.com/json-iterator/go v1.1.10 8 | ) 9 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 2 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 3 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= 5 | github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs= 6 | github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 7 | github.com/json-iterator/go v1.1.10 h1:Kz6Cvnvv2wGdaG/V8yMvfkmNiXq9Ya2KUv4rouJJr68= 8 | github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= 9 | github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc= 10 | github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= 11 | github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg= 12 | github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= 13 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 14 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 15 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 16 | github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= 17 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 18 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Go-MispFeedGenerator 2 | 3 | Generate MISP feeds without a MISP Instance! 4 | 5 | Go-MispFeedGenerator aka Go-MFG1000, is a library providing all functions needed to create events, adding attributes and generating needed feed files. Generated files can be consumed by any MISP instance. 6 | 7 | Go-MispFeedGenerator has been created by manually reverse engineering [PyMisp-FeedGenerator] 8 | 9 | Important Note: Go-MispFeedGenerator is not as sophisticated as [PyMisp] and [PyMisp-FeedGenerator]. For bugs and consumption issues on MISP, issue and pull requests are welcomed. 10 | 11 | ## Capabilities 12 | 13 | * Create Event 14 | * Created event automatically gets a UUID and time fields 15 | * Add attribute to Event with type and with optional category 16 | * If category is not provided, library fetches the [attributeTypes.json] from official pymisp repo and gets the first category including the type 17 | * If category is provided, library checks the type/category against [attributeTypes.json] from official pymisp repo 18 | * Adding tags to event 19 | * Generate Feed 20 | * Library can generate event json with naming convention "EventUUID.json" 21 | * Generate Feed Metadata 22 | * Library can generate manifest.json and hashes.csv files alongside feed event 23 | * Library checks existing manifest.json, hashes.csv files. New feed data will be appended to existing ones. (Note: for event feed files like EventUUID.json, a new file will be generated each time. For multiple events, multiple EventUUID.json should exist) 24 | 25 | 26 | ## Usage 27 | Install with: 28 | ````bash 29 | go get github.com/KaanSK/Go-MISPFeedGenerator 30 | ```` 31 | Check [Test Code](mispfeedgenerator_test.go) 32 | 33 | ```go 34 | func TestFeedGenerationWithMetadata(t *testing.T) { 35 | defer cleanGeneratedFiles() 36 | event, err := NewMispEvent() 37 | if err != nil { 38 | t.Errorf("Could not create new event") 39 | } 40 | event.Info = "Dummy event" 41 | event.Orgc.Name = "TEST ORG" 42 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 43 | event.AddTag("type:OSINT", "#004646") 44 | event.AddTag("tlp:white", "#005151") 45 | 46 | event.AddAttribute("email-dst", "111test1@test.com", "Network activity") 47 | event.AddAttribute("btc", "111a3246asd8asd4a8asf5as8afs65fd77a", "") 48 | event.AddAttribute("md5", "111847356890723489034292345875234", "") 49 | 50 | err = event.GenerateFeed(true) 51 | if err != nil { 52 | t.Errorf("Could not generate feed with manifest and hashes. Error: %s", err) 53 | } 54 | 55 | } 56 | ``` 57 | 58 | 59 | 60 | [PyMisp-FeedGenerator]: https://github.com/MISP/PyMISP/blob/main/examples/feed-generator/generate.py 61 | [PyMisp]: https://github.com/MISP/PyMISP 62 | [attributeTypes.json]: https://raw.githubusercontent.com/MISP/PyMISP/3c141e1fdb9127e10c5e7ec4784beb26af4b7ea7/pymisp/data/describeTypes.json -------------------------------------------------------------------------------- /mispfeedgenerator_test.go: -------------------------------------------------------------------------------- 1 | package mispfeedgenerator 2 | 3 | import ( 4 | "testing" 5 | ) 6 | 7 | // TestNewEvent test instanciation of MispEvent Object 8 | func TestNewEvent(t *testing.T) { 9 | _, err := NewMispEvent() 10 | if err != nil { 11 | t.Errorf("Could not create new event") 12 | } 13 | } 14 | 15 | // TestAddAttributewithNoCategory checks when attribute with no category 16 | // is added, the first found category is automatically put 17 | func TestAddAttributewithNoCategory(t *testing.T) { 18 | event, err := NewMispEvent() 19 | if err != nil { 20 | t.Errorf("Could not create new event") 21 | } 22 | event.Info = "Dummy event" 23 | event.Orgc.Name = "TEST ORG" 24 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 25 | 26 | err = event.AddAttribute("btc", "111a3246asd8asd4a8asf5as8afs65fd77a", "") 27 | 28 | if err != nil { 29 | t.Errorf("Could not add attribute") 30 | } 31 | if event.Attribute[0].Category == "" { 32 | t.Errorf("Category could not be put automatically for attribute") 33 | } 34 | } 35 | 36 | // TestAddTagsToEvent tests tag adding to event 37 | func TestAddTagsToEvent(t *testing.T) { 38 | event, err := NewMispEvent() 39 | if err != nil { 40 | t.Errorf("Could not create new event") 41 | } 42 | event.Info = "Dummy event" 43 | event.Orgc.Name = "TEST ORG" 44 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 45 | event.AddTag("test", "#004646") 46 | event.AddTag("test2", "#005151") 47 | 48 | if len(event.Tag) != 2 { 49 | t.Errorf("Could not add tags") 50 | } 51 | } 52 | 53 | // TestAddAttributewithValidCategory checks when a valid category is put to attribute 54 | // it passes the checking logic and stored in object 55 | func TestAddAttributewithValidCategory(t *testing.T) { 56 | event, err := NewMispEvent() 57 | if err != nil { 58 | t.Errorf("Could not create new event") 59 | } 60 | event.Info = "Dummy event" 61 | event.Orgc.Name = "TEST ORG" 62 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 63 | 64 | err = event.AddAttribute("email-dst", "111test1@test.com", "Network activity") 65 | if err != nil { 66 | t.Errorf("Could not add attribute") 67 | } 68 | if event.Attribute[0].Category != "Network activity" { 69 | t.Errorf("Category could not be put automatically for attribute") 70 | } 71 | } 72 | 73 | // TestAddAttributewithValidCategory checks when a valid category is put to attribute 74 | // it fails the checking logic and throws error 75 | func TestAddAttributewithInvalidCategory(t *testing.T) { 76 | event, err := NewMispEvent() 77 | if err != nil { 78 | t.Errorf("Could not create new event") 79 | } 80 | event.Info = "Dummy event" 81 | event.Orgc.Name = "TEST ORG" 82 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 83 | 84 | err = event.AddAttribute("btc", "111a3246asd8asd4a8asf5as8afs65fd77a", "Network activity") 85 | if err == nil { 86 | t.Errorf("Type-Category check does not work") 87 | } 88 | } 89 | 90 | // TestFeedGenerationWithMetadata testing if feed with manifest.json and hashes.csv 91 | // can be generated without errors. This test does not check the generated files. 92 | func TestFeedGenerationWithMetadata(t *testing.T) { 93 | defer cleanGeneratedFiles() 94 | event, err := NewMispEvent() 95 | if err != nil { 96 | t.Errorf("Could not create new event") 97 | } 98 | event.Info = "Dummy event" 99 | event.Orgc.Name = "TEST ORG" 100 | event.Orgc.UUID = "dc9de8b2-889c-42e5-a65f-68ecda38eed0" 101 | 102 | event.AddTag("test", "#004646") 103 | event.AddTag("test2", "#005151") 104 | event.AddAttribute("email-dst", "111test1@test.com", "Network activity") 105 | event.AddAttribute("btc", "111a3246asd8asd4a8asf5as8afs65fd77a", "") 106 | event.AddAttribute("md5", "111847356890723489034292345875234", "") 107 | 108 | err = event.GenerateFeed(true) 109 | if err != nil { 110 | t.Errorf("Could not generate feed with manifest and hashes. Error: %s", err) 111 | } 112 | 113 | } 114 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | package mispfeedgenerator 2 | 3 | import ( 4 | "crypto/md5" 5 | "encoding/csv" 6 | "encoding/hex" 7 | "encoding/json" 8 | "fmt" 9 | "io/ioutil" 10 | "net/http" 11 | "os" 12 | "path/filepath" 13 | "reflect" 14 | "strings" 15 | "time" 16 | 17 | jsoniter "github.com/json-iterator/go" 18 | ) 19 | 20 | func getJSON(url string, target interface{}) error { 21 | requestClient := &http.Client{Timeout: 10 * time.Second} 22 | r, err := requestClient.Get(url) 23 | if err != nil { 24 | return err 25 | } 26 | defer r.Body.Close() 27 | body, err := ioutil.ReadAll(r.Body) 28 | if err != nil { 29 | return err 30 | } 31 | var json = jsoniter.ConfigCompatibleWithStandardLibrary 32 | err = json.Unmarshal(body, target) 33 | return err 34 | } 35 | 36 | func getHash(data string) (string, error) { 37 | algorithm := md5.New() 38 | _, err := algorithm.Write([]byte(data)) 39 | if err != nil { 40 | return "", err 41 | } 42 | return hex.EncodeToString(algorithm.Sum(nil)), nil 43 | } 44 | 45 | func mergeMaps(maps ...map[string]interface{}) map[string]interface{} { 46 | result := make(map[string]interface{}) 47 | for _, m := range maps { 48 | for k, v := range m { 49 | result[k] = v 50 | } 51 | } 52 | return result 53 | } 54 | 55 | func writeStructToFile(obj map[string]interface{}, fileName string) (err error) { 56 | file, _ := json.MarshalIndent(obj, "", " ") 57 | if err := ioutil.WriteFile(fileName, file, 0644); err != nil { 58 | return err 59 | } 60 | return 61 | } 62 | 63 | func createHashesFile(me event) (err error) { 64 | var data = [][]string{} 65 | for _, att := range me.Attribute { 66 | data = append(data, []string{att._hash, me.UUID}) 67 | } 68 | file, err := os.OpenFile("hashes.csv", os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0644) 69 | if err != nil { 70 | return err 71 | } 72 | defer file.Close() 73 | writer := csv.NewWriter(file) 74 | defer writer.Flush() 75 | 76 | for _, value := range data { 77 | _ = writer.Write(value) 78 | } 79 | return 80 | } 81 | 82 | func createManifestFile(me event) (err error) { 83 | if _, err := os.Stat("manifest.json"); os.IsNotExist(err) { 84 | err = writeStructToFile(me._manifest, "manifest.json") 85 | if err != nil { 86 | return err 87 | } 88 | } else { 89 | data, err := ioutil.ReadFile("manifest.json") 90 | if err != nil { 91 | return err 92 | } 93 | existingManifests := make(map[string]interface{}) 94 | err = json.Unmarshal([]byte(data), &existingManifests) 95 | if err != nil { 96 | return err 97 | } 98 | 99 | finalManifest := mergeMaps(existingManifests, me._manifest) 100 | err = writeStructToFile(finalManifest, "manifest.json") 101 | if err != nil { 102 | return err 103 | } 104 | } 105 | return 106 | } 107 | 108 | func createEventFile(feedEvent map[string]interface{}) (err error) { 109 | uuid := feedEvent["Event"].(*event).UUID 110 | fileName := fmt.Sprintf("%s.json", uuid) 111 | err = writeStructToFile(feedEvent, fileName) 112 | if err != nil { 113 | return err 114 | } 115 | return 116 | } 117 | 118 | func normalizeFieldName(fieldName string) string { 119 | var g []string 120 | p := strings.Fields(fieldName) 121 | for _, value := range p { 122 | g = append(g, strings.Title(value)) 123 | } 124 | return strings.Join(g, "") 125 | } 126 | 127 | func getAttr(obj interface{}, fieldName string) reflect.Value { 128 | fieldName = normalizeFieldName(fieldName) 129 | pointToStruct := reflect.ValueOf(obj) // addressable 130 | curStruct := pointToStruct.Elem() 131 | if curStruct.Kind() != reflect.Struct { 132 | panic("not struct") 133 | } 134 | curField := curStruct.FieldByName(fieldName) // type: reflect.Value 135 | if !curField.IsValid() { 136 | panic("not found:" + fieldName) 137 | } 138 | return curField 139 | } 140 | 141 | func cleanGeneratedFiles() { 142 | feedJsons, _ := filepath.Glob("*json") 143 | metadata, _ := filepath.Glob("*csv") 144 | createdFiles := append(feedJsons, metadata...) 145 | 146 | for _, f := range createdFiles { 147 | if err := os.Remove(f); err != nil { 148 | panic(err) 149 | } 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /mispfeedgenerator.go: -------------------------------------------------------------------------------- 1 | // Package mispfeedgenerator used to generate MISP feeds without an instance. 2 | package mispfeedgenerator 3 | 4 | import ( 5 | "errors" 6 | "fmt" 7 | "reflect" 8 | "strings" 9 | "time" 10 | 11 | "github.com/google/uuid" 12 | ) 13 | 14 | // getAttributeTypes Fetches official Attribute types and categories from 15 | // https://raw.githubusercontent.com/MISP/PyMISP/main/pymisp/data/describeTypes.json 16 | func getAttributeTypes() (attType attributeTypes, err error) { 17 | attTypes := attributeTypes{} 18 | err = getJSON("https://raw.githubusercontent.com/MISP/PyMISP/main/pymisp/data/describeTypes.json", &attTypes) 19 | return attTypes, err 20 | } 21 | 22 | // NewMispEvent Used to instantiate a MISP event 23 | func NewMispEvent() (event, error) { 24 | mispEvent := event{} 25 | fetchedAttTypes, err := getAttributeTypes() 26 | if err != nil { 27 | return mispEvent, err 28 | } 29 | 30 | mispEvent._attributeTypes = fetchedAttTypes 31 | mispEvent._fieldsForFeed = []string{"uuid", "info", "threat_level_id", "analysis", "timestamp", "publish_timestamp", "published", "date", "extends_uuid"} 32 | mispEvent.UUID = uuid.NewString() 33 | mispEvent.Published = true 34 | mispEvent.Tag = []tag{} 35 | 36 | currentTime := time.Now() 37 | currentTimestamp := fmt.Sprint(currentTime.Unix()) 38 | 39 | mispEvent.Date = currentTime.UTC().Format("2006-01-02") 40 | mispEvent.PublishTimestamp = currentTimestamp 41 | mispEvent.StrTimestamp = currentTimestamp 42 | 43 | return mispEvent, nil 44 | } 45 | 46 | // validateAttributeType Used to validate attribute type against categories provided in 47 | // https://raw.githubusercontent.com/MISP/PyMISP/main/pymisp/data/describeTypes.json 48 | func (me *event) validateAttributeType(data string) bool { 49 | for _, value := range me._attributeTypes.Result.Types { 50 | if value == data { 51 | return true 52 | } 53 | } 54 | return false 55 | } 56 | 57 | // GenerateFeed used to generate feed files. 'withMeta' parameter should be true when 58 | // hashes.csv and manifest.json is needed. 59 | // 60 | // It automatically checks if there are files generated before and appends manifest.json, 61 | // hashes.csv to existing ones. 62 | func (me *event) GenerateFeed(withMeta bool) (err error) { 63 | if me.Info == "" || me.Orgc == (orgc{}) { 64 | return errors.New("Info or Orgc fields can not be empty") 65 | } 66 | if me.Orgc.UUID == "" { 67 | me.Orgc.UUID = uuid.NewString() 68 | } 69 | // analysis: 0 means initial, 1 ongoing, 2 completed 70 | if me.Analysis == 0 { 71 | me.Analysis = 2 72 | } 73 | 74 | if me.ThreatLevelID == 0 { 75 | me.ThreatLevelID = 4 76 | } 77 | 78 | err = me.computeHashFieldsForAttributes() 79 | if err != nil { 80 | return err 81 | } 82 | 83 | me._manifest = map[string]interface{}{ 84 | me.UUID: map[string]interface{}{ 85 | "Orgc": me.Orgc, 86 | "Tag": me.Tag, 87 | "info": me.Info, 88 | "date": me.Date, 89 | "analysis": me.Analysis, 90 | "threat_level_id": me.ThreatLevelID, 91 | "timestamp": me.StrTimestamp, 92 | }, 93 | } 94 | feedEvent := map[string]interface{}{ 95 | "Event": me, 96 | } 97 | 98 | err = createEventFile(feedEvent) 99 | if err != nil { 100 | return err 101 | } 102 | 103 | if withMeta { 104 | err = createManifestFile(*me) 105 | if err != nil { 106 | return err 107 | } 108 | err = createHashesFile(*me) 109 | if err != nil { 110 | return err 111 | } 112 | } 113 | 114 | return 115 | 116 | } 117 | 118 | func (me *event) computeHashFieldsForAttributes() (err error) { 119 | hashes := []string{} 120 | for idx, att := range me.Attribute { 121 | if strings.Contains(att.Type, "|") || att.Type == "malware-sample" { 122 | for _, data := range strings.Split(att.Value, "|") { 123 | computedHash, err := getHash(data) 124 | if err != nil { 125 | return err 126 | } 127 | me.Attribute[idx]._hash = computedHash 128 | hashes = append(hashes, computedHash) 129 | } 130 | } else { 131 | computedHash, err := getHash(att.Value) 132 | if err != nil { 133 | return err 134 | } 135 | me.Attribute[idx]._hash = computedHash 136 | hashes = append(hashes, computedHash) 137 | } 138 | } 139 | me._hashes = hashes 140 | return 141 | } 142 | 143 | func (me *event) getAttributeCategory(attType string) string { 144 | v := reflect.ValueOf(me._attributeTypes.Result.CategoryTypeMappings) 145 | for i := 0; i < v.NumField(); i++ { 146 | val := v.Field(i).Interface().([]string) 147 | for _, value := range val { 148 | if value == attType { 149 | return v.Type().Field(i).Name 150 | } 151 | } 152 | } 153 | return "" 154 | } 155 | 156 | func (me *event) checkTypeCategory(attType string, category string) bool { 157 | categoryTypeMappings := me._attributeTypes.Result.CategoryTypeMappings 158 | 159 | typesInCategory := getAttr(&categoryTypeMappings, category) 160 | for _, typeInCategory := range typesInCategory.Interface().([]string) { 161 | if typeInCategory == attType { 162 | return true 163 | } 164 | } 165 | return false 166 | } 167 | 168 | func (me *event) AddAttribute(dataType string, data string, category string) (err error) { 169 | if category != "" { 170 | if !me.checkTypeCategory(dataType, category) { 171 | return errors.New("Datatype does not belong to Category") 172 | } 173 | } else { 174 | category = me.getAttributeCategory(dataType) 175 | } 176 | 177 | dataTypeExists := me.validateAttributeType(dataType) 178 | if !dataTypeExists { 179 | return errors.New("Datatype does not exist") 180 | } 181 | 182 | att := newAttribute() 183 | att.UUID = uuid.NewString() 184 | att.StrTimestamp = me.StrTimestamp 185 | dataType = strings.ToLower(dataType) 186 | att.Value = data 187 | att.Type = dataType 188 | att.Category = category 189 | me.Attribute = append(me.Attribute, att) 190 | 191 | return nil 192 | } 193 | 194 | func (me *event) AddTag(name string, colour string) { 195 | tag := tag{Name: name, Colour: colour} 196 | me.Tag = append(me.Tag, tag) 197 | } 198 | 199 | func newAttribute() attribute { 200 | att := attribute{} 201 | att._fieldsForFeed = []string{"uuid", "value", "category", "type", "comment", "data", "deleted", "timestamp", "to_ids", "disable_correlation", "first_seen", "last_seen"} 202 | return att 203 | } 204 | -------------------------------------------------------------------------------- /model.go: -------------------------------------------------------------------------------- 1 | package mispfeedgenerator 2 | 3 | type attribute struct { 4 | _fieldsForFeed []string `json:"-"` 5 | _hash string `json:"-"` 6 | Value string `json:"value"` 7 | StrTimestamp string `json:"timestamp"` 8 | Comment string `json:"comment"` 9 | Category string `json:"category"` 10 | UUID string `json:"uuid"` 11 | Type string `json:"type"` 12 | ToIds bool `json:"to_ids"` 13 | Deleted bool `json:"deleted"` 14 | DisableCorrelation bool `json:"disable_correlation"` 15 | } 16 | 17 | type orgc struct { 18 | Name string `json:"name"` 19 | UUID string `json:"uuid"` 20 | } 21 | 22 | type eventManifest struct { 23 | Orgc orgc `json:"Orgc"` 24 | Tag []tag `json:"Tag"` 25 | Info string `json:"info"` 26 | Date string `json:"date"` 27 | Analysis int `json:"analysis"` 28 | ThreatLevelID int `json:"threat_level_id"` 29 | StrTimestamp string `json:"timestamp"` 30 | } 31 | 32 | type tag struct { 33 | Name string `json:"name"` 34 | Colour string `json:"colour"` 35 | } 36 | 37 | // Object is used for storing tag information 38 | type Object struct { 39 | StrTimestamp string `json:"timestamp"` 40 | SharingGroupID string `json:"sharing_group_id"` 41 | Description string `json:"description"` 42 | Name string `json:"name"` 43 | Comment string `json:"comment"` 44 | UUID string `json:"uuid"` 45 | TemplateVersion string `json:"template_version"` 46 | Distribution string `json:"distribution"` 47 | Deleted bool `json:"deleted"` 48 | TemplateUUID string `json:"template_uuid"` 49 | MetaCategory string `json:"meta-category"` 50 | ObjectReference []struct { 51 | Timestamp string `json:"timestamp"` 52 | RelationshipType string `json:"relationship_type"` 53 | ObjectUUID string `json:"object_uuid"` 54 | Comment string `json:"comment"` 55 | UUID string `json:"uuid"` 56 | ReferencedUUID string `json:"referenced_uuid"` 57 | } `json:"ObjectReference,omitempty"` 58 | Attribute []struct { 59 | Value string `json:"value"` 60 | StrTimestamp string `json:"timestamp"` 61 | Comment string `json:"comment"` 62 | Category string `json:"category"` 63 | UUID string `json:"uuid"` 64 | ObjectRelation string `json:"object_relation"` 65 | Type string `json:"type"` 66 | ToIds bool `json:"to_ids"` 67 | Deleted bool `json:"deleted"` 68 | DisableCorrelation bool `json:"disable_correlation"` 69 | } `json:"Attribute"` 70 | } 71 | 72 | // Event definition 73 | type event struct { 74 | _fieldsForFeed []string `json:"-"` 75 | _manifest map[string]interface{} `json:"-"` 76 | _hashes []string `json:"-"` 77 | _attributeTypes attributeTypes `json:"-"` 78 | StrTimestamp string `json:"timestamp"` 79 | ExtendsUUID string `json:"extends_uuid"` 80 | Info string `json:"info"` 81 | Date string `json:"date"` 82 | UUID string `json:"uuid"` 83 | // Analysis: 0 means initial, 1 ongoing, 2 completed 84 | Analysis int `json:"analysis"` 85 | PublishTimestamp string `json:"publish_timestamp"` 86 | Published bool `json:"published"` 87 | ThreatLevelID int `json:"threat_level_id"` 88 | Orgc orgc `json:"Orgc"` 89 | Tag []tag `json:"Tag"` 90 | Attribute []attribute `json:"Attribute"` 91 | Object []Object `json:"Object"` 92 | } 93 | 94 | type eventFeed struct { 95 | Event event `json:"Event"` 96 | } 97 | 98 | type attributeTypes struct { 99 | Result struct { 100 | Categories []string `json:"categories"` 101 | CategoryTypeMappings struct { 102 | AntivirusDetection []string `json:"Antivirus detection"` 103 | ArtifactsDropped []string `json:"Artifacts dropped"` 104 | Attribution []string `json:"Attribution"` 105 | ExternalAnalysis []string `json:"External analysis"` 106 | FinancialFraud []string `json:"Financial fraud"` 107 | InternalReference []string `json:"Internal reference"` 108 | NetworkActivity []string `json:"Network activity"` 109 | Other []string `json:"Other"` 110 | PayloadDelivery []string `json:"Payload delivery"` 111 | PayloadInstallation []string `json:"Payload installation"` 112 | PayloadType []string `json:"Payload type"` 113 | PersistenceMechanism []string `json:"Persistence mechanism"` 114 | Person []string `json:"Person"` 115 | SocialNetwork []string `json:"Social network"` 116 | SupportTool []string `json:"Support Tool"` 117 | TargetingData []string `json:"Targeting data"` 118 | } `json:"category_type_mappings"` 119 | SaneDefaults struct { 120 | As struct { 121 | DefaultCategory string `json:"default_category"` 122 | ToIds int `json:"to_ids"` 123 | } `json:"AS"` 124 | AbaRtn struct { 125 | DefaultCategory string `json:"default_category"` 126 | ToIds int `json:"to_ids"` 127 | } `json:"aba-rtn"` 128 | Anonymised struct { 129 | DefaultCategory string `json:"default_category"` 130 | ToIds int `json:"to_ids"` 131 | } `json:"anonymised"` 132 | Attachment struct { 133 | DefaultCategory string `json:"default_category"` 134 | ToIds int `json:"to_ids"` 135 | } `json:"attachment"` 136 | Authentihash struct { 137 | DefaultCategory string `json:"default_category"` 138 | ToIds int `json:"to_ids"` 139 | } `json:"authentihash"` 140 | BankAccountNr struct { 141 | DefaultCategory string `json:"default_category"` 142 | ToIds int `json:"to_ids"` 143 | } `json:"bank-account-nr"` 144 | Bic struct { 145 | DefaultCategory string `json:"default_category"` 146 | ToIds int `json:"to_ids"` 147 | } `json:"bic"` 148 | Bin struct { 149 | DefaultCategory string `json:"default_category"` 150 | ToIds int `json:"to_ids"` 151 | } `json:"bin"` 152 | Boolean struct { 153 | DefaultCategory string `json:"default_category"` 154 | ToIds int `json:"to_ids"` 155 | } `json:"boolean"` 156 | Bro struct { 157 | DefaultCategory string `json:"default_category"` 158 | ToIds int `json:"to_ids"` 159 | } `json:"bro"` 160 | Btc struct { 161 | DefaultCategory string `json:"default_category"` 162 | ToIds int `json:"to_ids"` 163 | } `json:"btc"` 164 | CampaignID struct { 165 | DefaultCategory string `json:"default_category"` 166 | ToIds int `json:"to_ids"` 167 | } `json:"campaign-id"` 168 | CampaignName struct { 169 | DefaultCategory string `json:"default_category"` 170 | ToIds int `json:"to_ids"` 171 | } `json:"campaign-name"` 172 | CcNumber struct { 173 | DefaultCategory string `json:"default_category"` 174 | ToIds int `json:"to_ids"` 175 | } `json:"cc-number"` 176 | Cdhash struct { 177 | DefaultCategory string `json:"default_category"` 178 | ToIds int `json:"to_ids"` 179 | } `json:"cdhash"` 180 | ChromeExtensionID struct { 181 | DefaultCategory string `json:"default_category"` 182 | ToIds int `json:"to_ids"` 183 | } `json:"chrome-extension-id"` 184 | Comment struct { 185 | DefaultCategory string `json:"default_category"` 186 | ToIds int `json:"to_ids"` 187 | } `json:"comment"` 188 | CommunityID struct { 189 | DefaultCategory string `json:"default_category"` 190 | ToIds int `json:"to_ids"` 191 | } `json:"community-id"` 192 | Cookie struct { 193 | DefaultCategory string `json:"default_category"` 194 | ToIds int `json:"to_ids"` 195 | } `json:"cookie"` 196 | Cortex struct { 197 | DefaultCategory string `json:"default_category"` 198 | ToIds int `json:"to_ids"` 199 | } `json:"cortex"` 200 | Counter struct { 201 | DefaultCategory string `json:"default_category"` 202 | ToIds int `json:"to_ids"` 203 | } `json:"counter"` 204 | CountryOfResidence struct { 205 | DefaultCategory string `json:"default_category"` 206 | ToIds int `json:"to_ids"` 207 | } `json:"country-of-residence"` 208 | Cpe struct { 209 | DefaultCategory string `json:"default_category"` 210 | ToIds int `json:"to_ids"` 211 | } `json:"cpe"` 212 | Dash struct { 213 | DefaultCategory string `json:"default_category"` 214 | ToIds int `json:"to_ids"` 215 | } `json:"dash"` 216 | DateOfBirth struct { 217 | DefaultCategory string `json:"default_category"` 218 | ToIds int `json:"to_ids"` 219 | } `json:"date-of-birth"` 220 | Datetime struct { 221 | DefaultCategory string `json:"default_category"` 222 | ToIds int `json:"to_ids"` 223 | } `json:"datetime"` 224 | Dkim struct { 225 | DefaultCategory string `json:"default_category"` 226 | ToIds int `json:"to_ids"` 227 | } `json:"dkim"` 228 | DkimSignature struct { 229 | DefaultCategory string `json:"default_category"` 230 | ToIds int `json:"to_ids"` 231 | } `json:"dkim-signature"` 232 | DNSSoaEmail struct { 233 | DefaultCategory string `json:"default_category"` 234 | ToIds int `json:"to_ids"` 235 | } `json:"dns-soa-email"` 236 | Domain struct { 237 | DefaultCategory string `json:"default_category"` 238 | ToIds int `json:"to_ids"` 239 | } `json:"domain"` 240 | DomainIP struct { 241 | DefaultCategory string `json:"default_category"` 242 | ToIds int `json:"to_ids"` 243 | } `json:"domain|ip"` 244 | Email struct { 245 | DefaultCategory string `json:"default_category"` 246 | ToIds int `json:"to_ids"` 247 | } `json:"email"` 248 | EmailAttachment struct { 249 | DefaultCategory string `json:"default_category"` 250 | ToIds int `json:"to_ids"` 251 | } `json:"email-attachment"` 252 | EmailBody struct { 253 | DefaultCategory string `json:"default_category"` 254 | ToIds int `json:"to_ids"` 255 | } `json:"email-body"` 256 | EmailDst struct { 257 | DefaultCategory string `json:"default_category"` 258 | ToIds int `json:"to_ids"` 259 | } `json:"email-dst"` 260 | EmailDstDisplayName struct { 261 | DefaultCategory string `json:"default_category"` 262 | ToIds int `json:"to_ids"` 263 | } `json:"email-dst-display-name"` 264 | EmailHeader struct { 265 | DefaultCategory string `json:"default_category"` 266 | ToIds int `json:"to_ids"` 267 | } `json:"email-header"` 268 | EmailMessageID struct { 269 | DefaultCategory string `json:"default_category"` 270 | ToIds int `json:"to_ids"` 271 | } `json:"email-message-id"` 272 | EmailMimeBoundary struct { 273 | DefaultCategory string `json:"default_category"` 274 | ToIds int `json:"to_ids"` 275 | } `json:"email-mime-boundary"` 276 | EmailReplyTo struct { 277 | DefaultCategory string `json:"default_category"` 278 | ToIds int `json:"to_ids"` 279 | } `json:"email-reply-to"` 280 | EmailSrc struct { 281 | DefaultCategory string `json:"default_category"` 282 | ToIds int `json:"to_ids"` 283 | } `json:"email-src"` 284 | EmailSrcDisplayName struct { 285 | DefaultCategory string `json:"default_category"` 286 | ToIds int `json:"to_ids"` 287 | } `json:"email-src-display-name"` 288 | EmailSubject struct { 289 | DefaultCategory string `json:"default_category"` 290 | ToIds int `json:"to_ids"` 291 | } `json:"email-subject"` 292 | EmailThreadIndex struct { 293 | DefaultCategory string `json:"default_category"` 294 | ToIds int `json:"to_ids"` 295 | } `json:"email-thread-index"` 296 | EmailXMailer struct { 297 | DefaultCategory string `json:"default_category"` 298 | ToIds int `json:"to_ids"` 299 | } `json:"email-x-mailer"` 300 | Eppn struct { 301 | DefaultCategory string `json:"default_category"` 302 | ToIds int `json:"to_ids"` 303 | } `json:"eppn"` 304 | FaviconMmh3 struct { 305 | DefaultCategory string `json:"default_category"` 306 | ToIds int `json:"to_ids"` 307 | } `json:"favicon-mmh3"` 308 | Filename struct { 309 | DefaultCategory string `json:"default_category"` 310 | ToIds int `json:"to_ids"` 311 | } `json:"filename"` 312 | FilenameAuthentihash struct { 313 | DefaultCategory string `json:"default_category"` 314 | ToIds int `json:"to_ids"` 315 | } `json:"filename|authentihash"` 316 | FilenameImpfuzzy struct { 317 | DefaultCategory string `json:"default_category"` 318 | ToIds int `json:"to_ids"` 319 | } `json:"filename|impfuzzy"` 320 | FilenameImphash struct { 321 | DefaultCategory string `json:"default_category"` 322 | ToIds int `json:"to_ids"` 323 | } `json:"filename|imphash"` 324 | FilenameMd5 struct { 325 | DefaultCategory string `json:"default_category"` 326 | ToIds int `json:"to_ids"` 327 | } `json:"filename|md5"` 328 | FilenamePehash struct { 329 | DefaultCategory string `json:"default_category"` 330 | ToIds int `json:"to_ids"` 331 | } `json:"filename|pehash"` 332 | FilenameSha1 struct { 333 | DefaultCategory string `json:"default_category"` 334 | ToIds int `json:"to_ids"` 335 | } `json:"filename|sha1"` 336 | FilenameSha224 struct { 337 | DefaultCategory string `json:"default_category"` 338 | ToIds int `json:"to_ids"` 339 | } `json:"filename|sha224"` 340 | FilenameSha256 struct { 341 | DefaultCategory string `json:"default_category"` 342 | ToIds int `json:"to_ids"` 343 | } `json:"filename|sha256"` 344 | FilenameSha3224 struct { 345 | DefaultCategory string `json:"default_category"` 346 | ToIds int `json:"to_ids"` 347 | } `json:"filename|sha3-224"` 348 | FilenameSha3256 struct { 349 | DefaultCategory string `json:"default_category"` 350 | ToIds int `json:"to_ids"` 351 | } `json:"filename|sha3-256"` 352 | FilenameSha3384 struct { 353 | DefaultCategory string `json:"default_category"` 354 | ToIds int `json:"to_ids"` 355 | } `json:"filename|sha3-384"` 356 | FilenameSha3512 struct { 357 | DefaultCategory string `json:"default_category"` 358 | ToIds int `json:"to_ids"` 359 | } `json:"filename|sha3-512"` 360 | FilenameSha384 struct { 361 | DefaultCategory string `json:"default_category"` 362 | ToIds int `json:"to_ids"` 363 | } `json:"filename|sha384"` 364 | FilenameSha512 struct { 365 | DefaultCategory string `json:"default_category"` 366 | ToIds int `json:"to_ids"` 367 | } `json:"filename|sha512"` 368 | FilenameSha512224 struct { 369 | DefaultCategory string `json:"default_category"` 370 | ToIds int `json:"to_ids"` 371 | } `json:"filename|sha512/224"` 372 | FilenameSha512256 struct { 373 | DefaultCategory string `json:"default_category"` 374 | ToIds int `json:"to_ids"` 375 | } `json:"filename|sha512/256"` 376 | FilenameSsdeep struct { 377 | DefaultCategory string `json:"default_category"` 378 | ToIds int `json:"to_ids"` 379 | } `json:"filename|ssdeep"` 380 | FilenameTlsh struct { 381 | DefaultCategory string `json:"default_category"` 382 | ToIds int `json:"to_ids"` 383 | } `json:"filename|tlsh"` 384 | FilenameVhash struct { 385 | DefaultCategory string `json:"default_category"` 386 | ToIds int `json:"to_ids"` 387 | } `json:"filename|vhash"` 388 | FirstName struct { 389 | DefaultCategory string `json:"default_category"` 390 | ToIds int `json:"to_ids"` 391 | } `json:"first-name"` 392 | Float struct { 393 | DefaultCategory string `json:"default_category"` 394 | ToIds int `json:"to_ids"` 395 | } `json:"float"` 396 | FrequentFlyerNumber struct { 397 | DefaultCategory string `json:"default_category"` 398 | ToIds int `json:"to_ids"` 399 | } `json:"frequent-flyer-number"` 400 | FullName struct { 401 | DefaultCategory string `json:"default_category"` 402 | ToIds int `json:"to_ids"` 403 | } `json:"full-name"` 404 | Gender struct { 405 | DefaultCategory string `json:"default_category"` 406 | ToIds int `json:"to_ids"` 407 | } `json:"gender"` 408 | Gene struct { 409 | DefaultCategory string `json:"default_category"` 410 | ToIds int `json:"to_ids"` 411 | } `json:"gene"` 412 | GitCommitID struct { 413 | DefaultCategory string `json:"default_category"` 414 | ToIds int `json:"to_ids"` 415 | } `json:"git-commit-id"` 416 | GithubOrganisation struct { 417 | DefaultCategory string `json:"default_category"` 418 | ToIds int `json:"to_ids"` 419 | } `json:"github-organisation"` 420 | GithubRepository struct { 421 | DefaultCategory string `json:"default_category"` 422 | ToIds int `json:"to_ids"` 423 | } `json:"github-repository"` 424 | GithubUsername struct { 425 | DefaultCategory string `json:"default_category"` 426 | ToIds int `json:"to_ids"` 427 | } `json:"github-username"` 428 | HasshMd5 struct { 429 | DefaultCategory string `json:"default_category"` 430 | ToIds int `json:"to_ids"` 431 | } `json:"hassh-md5"` 432 | HasshserverMd5 struct { 433 | DefaultCategory string `json:"default_category"` 434 | ToIds int `json:"to_ids"` 435 | } `json:"hasshserver-md5"` 436 | Hex struct { 437 | DefaultCategory string `json:"default_category"` 438 | ToIds int `json:"to_ids"` 439 | } `json:"hex"` 440 | Hostname struct { 441 | DefaultCategory string `json:"default_category"` 442 | ToIds int `json:"to_ids"` 443 | } `json:"hostname"` 444 | HostnamePort struct { 445 | DefaultCategory string `json:"default_category"` 446 | ToIds int `json:"to_ids"` 447 | } `json:"hostname|port"` 448 | HTTPMethod struct { 449 | DefaultCategory string `json:"default_category"` 450 | ToIds int `json:"to_ids"` 451 | } `json:"http-method"` 452 | Iban struct { 453 | DefaultCategory string `json:"default_category"` 454 | ToIds int `json:"to_ids"` 455 | } `json:"iban"` 456 | IdentityCardNumber struct { 457 | DefaultCategory string `json:"default_category"` 458 | ToIds int `json:"to_ids"` 459 | } `json:"identity-card-number"` 460 | Impfuzzy struct { 461 | DefaultCategory string `json:"default_category"` 462 | ToIds int `json:"to_ids"` 463 | } `json:"impfuzzy"` 464 | Imphash struct { 465 | DefaultCategory string `json:"default_category"` 466 | ToIds int `json:"to_ids"` 467 | } `json:"imphash"` 468 | IPDst struct { 469 | DefaultCategory string `json:"default_category"` 470 | ToIds int `json:"to_ids"` 471 | } `json:"ip-dst"` 472 | IPDstPort struct { 473 | DefaultCategory string `json:"default_category"` 474 | ToIds int `json:"to_ids"` 475 | } `json:"ip-dst|port"` 476 | IPSrc struct { 477 | DefaultCategory string `json:"default_category"` 478 | ToIds int `json:"to_ids"` 479 | } `json:"ip-src"` 480 | IPSrcPort struct { 481 | DefaultCategory string `json:"default_category"` 482 | ToIds int `json:"to_ids"` 483 | } `json:"ip-src|port"` 484 | IssueDateOfTheVisa struct { 485 | DefaultCategory string `json:"default_category"` 486 | ToIds int `json:"to_ids"` 487 | } `json:"issue-date-of-the-visa"` 488 | Ja3FingerprintMd5 struct { 489 | DefaultCategory string `json:"default_category"` 490 | ToIds int `json:"to_ids"` 491 | } `json:"ja3-fingerprint-md5"` 492 | JabberID struct { 493 | DefaultCategory string `json:"default_category"` 494 | ToIds int `json:"to_ids"` 495 | } `json:"jabber-id"` 496 | JarmFingerprint struct { 497 | DefaultCategory string `json:"default_category"` 498 | ToIds int `json:"to_ids"` 499 | } `json:"jarm-fingerprint"` 500 | KustoQuery struct { 501 | DefaultCategory string `json:"default_category"` 502 | ToIds int `json:"to_ids"` 503 | } `json:"kusto-query"` 504 | LastName struct { 505 | DefaultCategory string `json:"default_category"` 506 | ToIds int `json:"to_ids"` 507 | } `json:"last-name"` 508 | Link struct { 509 | DefaultCategory string `json:"default_category"` 510 | ToIds int `json:"to_ids"` 511 | } `json:"link"` 512 | MacAddress struct { 513 | DefaultCategory string `json:"default_category"` 514 | ToIds int `json:"to_ids"` 515 | } `json:"mac-address"` 516 | MacEui64 struct { 517 | DefaultCategory string `json:"default_category"` 518 | ToIds int `json:"to_ids"` 519 | } `json:"mac-eui-64"` 520 | MalwareSample struct { 521 | DefaultCategory string `json:"default_category"` 522 | ToIds int `json:"to_ids"` 523 | } `json:"malware-sample"` 524 | MalwareType struct { 525 | DefaultCategory string `json:"default_category"` 526 | ToIds int `json:"to_ids"` 527 | } `json:"malware-type"` 528 | Md5 struct { 529 | DefaultCategory string `json:"default_category"` 530 | ToIds int `json:"to_ids"` 531 | } `json:"md5"` 532 | MiddleName struct { 533 | DefaultCategory string `json:"default_category"` 534 | ToIds int `json:"to_ids"` 535 | } `json:"middle-name"` 536 | MimeType struct { 537 | DefaultCategory string `json:"default_category"` 538 | ToIds int `json:"to_ids"` 539 | } `json:"mime-type"` 540 | MobileApplicationID struct { 541 | DefaultCategory string `json:"default_category"` 542 | ToIds int `json:"to_ids"` 543 | } `json:"mobile-application-id"` 544 | Mutex struct { 545 | DefaultCategory string `json:"default_category"` 546 | ToIds int `json:"to_ids"` 547 | } `json:"mutex"` 548 | NamedPipe struct { 549 | DefaultCategory string `json:"default_category"` 550 | ToIds int `json:"to_ids"` 551 | } `json:"named pipe"` 552 | Nationality struct { 553 | DefaultCategory string `json:"default_category"` 554 | ToIds int `json:"to_ids"` 555 | } `json:"nationality"` 556 | Other struct { 557 | DefaultCategory string `json:"default_category"` 558 | ToIds int `json:"to_ids"` 559 | } `json:"other"` 560 | PassengerNameRecordLocatorNumber struct { 561 | DefaultCategory string `json:"default_category"` 562 | ToIds int `json:"to_ids"` 563 | } `json:"passenger-name-record-locator-number"` 564 | PassportCountry struct { 565 | DefaultCategory string `json:"default_category"` 566 | ToIds int `json:"to_ids"` 567 | } `json:"passport-country"` 568 | PassportExpiration struct { 569 | DefaultCategory string `json:"default_category"` 570 | ToIds int `json:"to_ids"` 571 | } `json:"passport-expiration"` 572 | PassportNumber struct { 573 | DefaultCategory string `json:"default_category"` 574 | ToIds int `json:"to_ids"` 575 | } `json:"passport-number"` 576 | PatternFilename struct { 577 | DefaultCategory string `json:"default_category"` 578 | ToIds int `json:"to_ids"` 579 | } `json:"pattern-filename"` 580 | PatternInFile struct { 581 | DefaultCategory string `json:"default_category"` 582 | ToIds int `json:"to_ids"` 583 | } `json:"pattern-in-file"` 584 | PatternInMemory struct { 585 | DefaultCategory string `json:"default_category"` 586 | ToIds int `json:"to_ids"` 587 | } `json:"pattern-in-memory"` 588 | PatternInTraffic struct { 589 | DefaultCategory string `json:"default_category"` 590 | ToIds int `json:"to_ids"` 591 | } `json:"pattern-in-traffic"` 592 | PaymentDetails struct { 593 | DefaultCategory string `json:"default_category"` 594 | ToIds int `json:"to_ids"` 595 | } `json:"payment-details"` 596 | Pdb struct { 597 | DefaultCategory string `json:"default_category"` 598 | ToIds int `json:"to_ids"` 599 | } `json:"pdb"` 600 | Pehash struct { 601 | DefaultCategory string `json:"default_category"` 602 | ToIds int `json:"to_ids"` 603 | } `json:"pehash"` 604 | PgpPrivateKey struct { 605 | DefaultCategory string `json:"default_category"` 606 | ToIds int `json:"to_ids"` 607 | } `json:"pgp-private-key"` 608 | PgpPublicKey struct { 609 | DefaultCategory string `json:"default_category"` 610 | ToIds int `json:"to_ids"` 611 | } `json:"pgp-public-key"` 612 | PhoneNumber struct { 613 | DefaultCategory string `json:"default_category"` 614 | ToIds int `json:"to_ids"` 615 | } `json:"phone-number"` 616 | PlaceOfBirth struct { 617 | DefaultCategory string `json:"default_category"` 618 | ToIds int `json:"to_ids"` 619 | } `json:"place-of-birth"` 620 | PlacePortOfClearance struct { 621 | DefaultCategory string `json:"default_category"` 622 | ToIds int `json:"to_ids"` 623 | } `json:"place-port-of-clearance"` 624 | PlacePortOfOnwardForeignDestination struct { 625 | DefaultCategory string `json:"default_category"` 626 | ToIds int `json:"to_ids"` 627 | } `json:"place-port-of-onward-foreign-destination"` 628 | PlacePortOfOriginalEmbarkation struct { 629 | DefaultCategory string `json:"default_category"` 630 | ToIds int `json:"to_ids"` 631 | } `json:"place-port-of-original-embarkation"` 632 | Port struct { 633 | DefaultCategory string `json:"default_category"` 634 | ToIds int `json:"to_ids"` 635 | } `json:"port"` 636 | PrimaryResidence struct { 637 | DefaultCategory string `json:"default_category"` 638 | ToIds int `json:"to_ids"` 639 | } `json:"primary-residence"` 640 | ProcessState struct { 641 | DefaultCategory string `json:"default_category"` 642 | ToIds int `json:"to_ids"` 643 | } `json:"process-state"` 644 | Prtn struct { 645 | DefaultCategory string `json:"default_category"` 646 | ToIds int `json:"to_ids"` 647 | } `json:"prtn"` 648 | RedressNumber struct { 649 | DefaultCategory string `json:"default_category"` 650 | ToIds int `json:"to_ids"` 651 | } `json:"redress-number"` 652 | Regkey struct { 653 | DefaultCategory string `json:"default_category"` 654 | ToIds int `json:"to_ids"` 655 | } `json:"regkey"` 656 | RegkeyValue struct { 657 | DefaultCategory string `json:"default_category"` 658 | ToIds int `json:"to_ids"` 659 | } `json:"regkey|value"` 660 | Sha1 struct { 661 | DefaultCategory string `json:"default_category"` 662 | ToIds int `json:"to_ids"` 663 | } `json:"sha1"` 664 | Sha224 struct { 665 | DefaultCategory string `json:"default_category"` 666 | ToIds int `json:"to_ids"` 667 | } `json:"sha224"` 668 | Sha256 struct { 669 | DefaultCategory string `json:"default_category"` 670 | ToIds int `json:"to_ids"` 671 | } `json:"sha256"` 672 | Sha3224 struct { 673 | DefaultCategory string `json:"default_category"` 674 | ToIds int `json:"to_ids"` 675 | } `json:"sha3-224"` 676 | Sha3256 struct { 677 | DefaultCategory string `json:"default_category"` 678 | ToIds int `json:"to_ids"` 679 | } `json:"sha3-256"` 680 | Sha3384 struct { 681 | DefaultCategory string `json:"default_category"` 682 | ToIds int `json:"to_ids"` 683 | } `json:"sha3-384"` 684 | Sha3512 struct { 685 | DefaultCategory string `json:"default_category"` 686 | ToIds int `json:"to_ids"` 687 | } `json:"sha3-512"` 688 | Sha384 struct { 689 | DefaultCategory string `json:"default_category"` 690 | ToIds int `json:"to_ids"` 691 | } `json:"sha384"` 692 | Sha512 struct { 693 | DefaultCategory string `json:"default_category"` 694 | ToIds int `json:"to_ids"` 695 | } `json:"sha512"` 696 | Sha512224 struct { 697 | DefaultCategory string `json:"default_category"` 698 | ToIds int `json:"to_ids"` 699 | } `json:"sha512/224"` 700 | Sha512256 struct { 701 | DefaultCategory string `json:"default_category"` 702 | ToIds int `json:"to_ids"` 703 | } `json:"sha512/256"` 704 | Sigma struct { 705 | DefaultCategory string `json:"default_category"` 706 | ToIds int `json:"to_ids"` 707 | } `json:"sigma"` 708 | SizeInBytes struct { 709 | DefaultCategory string `json:"default_category"` 710 | ToIds int `json:"to_ids"` 711 | } `json:"size-in-bytes"` 712 | Snort struct { 713 | DefaultCategory string `json:"default_category"` 714 | ToIds int `json:"to_ids"` 715 | } `json:"snort"` 716 | SpecialServiceRequest struct { 717 | DefaultCategory string `json:"default_category"` 718 | ToIds int `json:"to_ids"` 719 | } `json:"special-service-request"` 720 | Ssdeep struct { 721 | DefaultCategory string `json:"default_category"` 722 | ToIds int `json:"to_ids"` 723 | } `json:"ssdeep"` 724 | Stix2Pattern struct { 725 | DefaultCategory string `json:"default_category"` 726 | ToIds int `json:"to_ids"` 727 | } `json:"stix2-pattern"` 728 | TargetEmail struct { 729 | DefaultCategory string `json:"default_category"` 730 | ToIds int `json:"to_ids"` 731 | } `json:"target-email"` 732 | TargetExternal struct { 733 | DefaultCategory string `json:"default_category"` 734 | ToIds int `json:"to_ids"` 735 | } `json:"target-external"` 736 | TargetLocation struct { 737 | DefaultCategory string `json:"default_category"` 738 | ToIds int `json:"to_ids"` 739 | } `json:"target-location"` 740 | TargetMachine struct { 741 | DefaultCategory string `json:"default_category"` 742 | ToIds int `json:"to_ids"` 743 | } `json:"target-machine"` 744 | TargetOrg struct { 745 | DefaultCategory string `json:"default_category"` 746 | ToIds int `json:"to_ids"` 747 | } `json:"target-org"` 748 | TargetUser struct { 749 | DefaultCategory string `json:"default_category"` 750 | ToIds int `json:"to_ids"` 751 | } `json:"target-user"` 752 | Telfhash struct { 753 | DefaultCategory string `json:"default_category"` 754 | ToIds int `json:"to_ids"` 755 | } `json:"telfhash"` 756 | Text struct { 757 | DefaultCategory string `json:"default_category"` 758 | ToIds int `json:"to_ids"` 759 | } `json:"text"` 760 | ThreatActor struct { 761 | DefaultCategory string `json:"default_category"` 762 | ToIds int `json:"to_ids"` 763 | } `json:"threat-actor"` 764 | Tlsh struct { 765 | DefaultCategory string `json:"default_category"` 766 | ToIds int `json:"to_ids"` 767 | } `json:"tlsh"` 768 | TravelDetails struct { 769 | DefaultCategory string `json:"default_category"` 770 | ToIds int `json:"to_ids"` 771 | } `json:"travel-details"` 772 | TwitterID struct { 773 | DefaultCategory string `json:"default_category"` 774 | ToIds int `json:"to_ids"` 775 | } `json:"twitter-id"` 776 | URI struct { 777 | DefaultCategory string `json:"default_category"` 778 | ToIds int `json:"to_ids"` 779 | } `json:"uri"` 780 | URL struct { 781 | DefaultCategory string `json:"default_category"` 782 | ToIds int `json:"to_ids"` 783 | } `json:"url"` 784 | UserAgent struct { 785 | DefaultCategory string `json:"default_category"` 786 | ToIds int `json:"to_ids"` 787 | } `json:"user-agent"` 788 | Vhash struct { 789 | DefaultCategory string `json:"default_category"` 790 | ToIds int `json:"to_ids"` 791 | } `json:"vhash"` 792 | VisaNumber struct { 793 | DefaultCategory string `json:"default_category"` 794 | ToIds int `json:"to_ids"` 795 | } `json:"visa-number"` 796 | Vulnerability struct { 797 | DefaultCategory string `json:"default_category"` 798 | ToIds int `json:"to_ids"` 799 | } `json:"vulnerability"` 800 | Weakness struct { 801 | DefaultCategory string `json:"default_category"` 802 | ToIds int `json:"to_ids"` 803 | } `json:"weakness"` 804 | WhoisCreationDate struct { 805 | DefaultCategory string `json:"default_category"` 806 | ToIds int `json:"to_ids"` 807 | } `json:"whois-creation-date"` 808 | WhoisRegistrantEmail struct { 809 | DefaultCategory string `json:"default_category"` 810 | ToIds int `json:"to_ids"` 811 | } `json:"whois-registrant-email"` 812 | WhoisRegistrantName struct { 813 | DefaultCategory string `json:"default_category"` 814 | ToIds int `json:"to_ids"` 815 | } `json:"whois-registrant-name"` 816 | WhoisRegistrantOrg struct { 817 | DefaultCategory string `json:"default_category"` 818 | ToIds int `json:"to_ids"` 819 | } `json:"whois-registrant-org"` 820 | WhoisRegistrantPhone struct { 821 | DefaultCategory string `json:"default_category"` 822 | ToIds int `json:"to_ids"` 823 | } `json:"whois-registrant-phone"` 824 | WhoisRegistrar struct { 825 | DefaultCategory string `json:"default_category"` 826 | ToIds int `json:"to_ids"` 827 | } `json:"whois-registrar"` 828 | WindowsScheduledTask struct { 829 | DefaultCategory string `json:"default_category"` 830 | ToIds int `json:"to_ids"` 831 | } `json:"windows-scheduled-task"` 832 | WindowsServiceDisplayname struct { 833 | DefaultCategory string `json:"default_category"` 834 | ToIds int `json:"to_ids"` 835 | } `json:"windows-service-displayname"` 836 | WindowsServiceName struct { 837 | DefaultCategory string `json:"default_category"` 838 | ToIds int `json:"to_ids"` 839 | } `json:"windows-service-name"` 840 | X509FingerprintMd5 struct { 841 | DefaultCategory string `json:"default_category"` 842 | ToIds int `json:"to_ids"` 843 | } `json:"x509-fingerprint-md5"` 844 | X509FingerprintSha1 struct { 845 | DefaultCategory string `json:"default_category"` 846 | ToIds int `json:"to_ids"` 847 | } `json:"x509-fingerprint-sha1"` 848 | X509FingerprintSha256 struct { 849 | DefaultCategory string `json:"default_category"` 850 | ToIds int `json:"to_ids"` 851 | } `json:"x509-fingerprint-sha256"` 852 | Xmr struct { 853 | DefaultCategory string `json:"default_category"` 854 | ToIds int `json:"to_ids"` 855 | } `json:"xmr"` 856 | Yara struct { 857 | DefaultCategory string `json:"default_category"` 858 | ToIds int `json:"to_ids"` 859 | } `json:"yara"` 860 | Zeek struct { 861 | DefaultCategory string `json:"default_category"` 862 | ToIds int `json:"to_ids"` 863 | } `json:"zeek"` 864 | } `json:"sane_defaults"` 865 | Types []string `json:"types"` 866 | } `json:"result"` 867 | } 868 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | --------------------------------------------------------------------------------