-
Notifications
You must be signed in to change notification settings - Fork 1
/
godradis.go
1923 lines (1673 loc) · 53.2 KB
/
godradis.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package godradis provides a full-featured library for accessing the Dradis server REST API.
package godradis
import (
"bytes"
"crypto/tls"
"encoding/json"
"fmt"
"github.com/iancoleman/orderedmap"
"github.com/pkg/errors"
"io"
"io/ioutil"
"mime/multipart"
"net/http"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
)
type Godradis struct {
Config Config
httpClient http.Client
}
// Configuration
type Config struct {
BaseUrl string `json:"dradis_url"`
ApiKey string `json:"api_key"`
Verify bool `json:"verify"`
}
/*
Configure populates godradis with parameters necessary to access the Dradis server. url should be the base url of the
Dradis server, before "/pro/api" and without a trailing "/" (e.g. https://example.com). apiKey is a string containing
the API key shown on the user's Dradis profile page. verify instructs godradis whether to check TLS certificates on the
Dradis server.
After creating the configuration, Configure creates an http.client on the Godradis object to be used for all subsequent
HTTP requests to the Dradis server.
gd := godradis.Godradis{}
gd.Configure("https://example.com", "abcdefghijk", false)
*/
func (gd *Godradis) Configure(url, apiKey string, verify bool) {
gd.Config = Config{url, apiKey, verify}
gd.createClient(verify)
}
/*
LoadConfig behaves the same way as Configure except that it loads the configuration parameters from a JSON file instead
of accepting them directly in the function call.
gd := godradis.Godradis{}
err := gd.LoadConfig("dradis_config.json")
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) LoadConfig(filename string) error {
file, err := os.Open(filename)
if err != nil {
return err
}
defer file.Close()
fileBytes, _ := ioutil.ReadAll(file)
err = json.Unmarshal(fileBytes, &gd.Config)
if err != nil {
return err
}
gd.createClient(gd.Config.Verify)
return nil
}
// Utils
func (gd *Godradis) createClient(verify bool) {
tr := &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: !verify},
}
gd.httpClient = http.Client{Transport: tr}
}
func (gd *Godradis) sendRequest(method, resource string, body []byte) (*http.Response, error) {
req, _ := http.NewRequest(method, fmt.Sprintf("%s/pro/api/%s", gd.Config.BaseUrl, resource), bytes.NewBuffer(body))
req.Header.Add("Authorization", fmt.Sprintf(`Token token="%s"`, gd.Config.ApiKey))
if method == "DELETE" || ((method == "POST" || method == "PUT") && body != nil) {
req.Header.Set("Content-Type", "application/json")
}
resp, err := gd.httpClient.Do(req)
if err != nil {
return resp, err
}
return resp, nil
}
func (gd *Godradis) sendRequestWithProjectId(method, resource string, projectId int, body []byte) (*http.Response, error) {
req, _ := http.NewRequest(method, fmt.Sprintf("%s/pro/api/%s", gd.Config.BaseUrl, resource), bytes.NewBuffer(body))
req.Header.Add("Authorization", fmt.Sprintf(`Token token="%s"`, gd.Config.ApiKey))
if method == "DELETE" || ((method == "POST" || method == "PUT") && body != nil) {
req.Header.Set("Content-Type", "application/json")
}
req.Header.Set("Dradis-Project-Id", strconv.Itoa(projectId))
resp, err := gd.httpClient.Do(req)
if err != nil {
return resp, err
}
return resp, nil
}
func parseOrderedMapFields(fields *orderedmap.OrderedMap) string {
text := ""
keys := fields.Keys()
for _, k := range keys {
v, _ := fields.Get(k)
text += fmt.Sprintf("#[%v]#\r\n%v\r\n\r\n", k, v)
}
return text
}
// Projects Endpoint
/*
GetAllProjects takes no arguments and retrieves a full list of all projects on the Dradis server. If an error of any kind
occurs, the function will return an empty rather than partial list as well as the error.
gd := godradis.Godradis{}
[...]
projectList, _ := gd.GetAllProjects()
if len(projectList) > 0 {
fmt.Printf("%v", projectList[0].Name)
}
*/
func (gd *Godradis) GetAllProjects() ([]Project, error) {
resp, err := gd.sendRequest("GET", "projects", nil)
if err != nil {
return []Project{}, err
}
defer resp.Body.Close()
var projects []Project
if resp.StatusCode != http.StatusOK {
return []Project{}, errors.New("could not get projects from server")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return []Project{}, err
}
err = json.Unmarshal(body, &projects)
if err != nil {
return []Project{}, err
}
return projects, nil
}
/*
GetProjectById fetches a Project object from the Dradis server based on the int id.
gd := godradis.Godradis{}
[...]
project, err := gd.GetProjectById(45)
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) GetProjectById(id int) (Project, error) {
resp, err := gd.sendRequest("GET", fmt.Sprintf("projects/%v", id), nil)
if err != nil {
return Project{}, err
}
defer resp.Body.Close()
var project Project
if resp.StatusCode != http.StatusOK {
return Project{}, errors.New("could not get project from server")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Project{}, err
}
err = json.Unmarshal(body, &project)
if err != nil {
return Project{}, err
}
return project, nil
}
/*
GetProjectByName searches for and returns a Project object based on the name. GetProjectByName works by calling GetAllProjects
first and then ranges over them comparing the name strings.
gd := godradis.Godradis{}
[...]
project, err := gd.GetProjectByName("Foobar External Network Penetration Test")
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) GetProjectByName(name string) (Project, error) {
projects, err := gd.GetAllProjects()
if err != nil {
return Project{}, err
}
for _, project := range projects {
if strings.ToLower(project.Name) == strings.ToLower(name) {
return project, nil
}
}
return Project{}, errors.New(fmt.Sprintf("Could not find project %s", name))
}
type projectDetails struct {
Name string `json:"name,omitempty"`
ClientId int `json:"team_id,omitempty"` // For some reason, POST/PUT methods use strings instead of ints even though they return ints
ReportTemplatePropertiesId int `json:"report_template_properties_id,omitempty"`
AuthorIds []int `json:"author_ids,omitempty"`
Template string `json:"template,omitempty"`
}
func (pd *projectDetails) parseArguments(name, clientId, reportTemplatePropertiesId interface{}, authorIds []int, template interface{}) {
if name == nil {
pd.Name = ""
} else {
pd.Name = name.(string)
}
if clientId == nil {
pd.ClientId = 0
} else {
pd.ClientId = clientId.(int)
}
if reportTemplatePropertiesId == nil {
pd.ReportTemplatePropertiesId = 0
} else {
pd.ReportTemplatePropertiesId = reportTemplatePropertiesId.(int)
}
pd.AuthorIds = authorIds
if template == nil {
pd.Template = ""
} else {
pd.Template = template.(string)
}
}
/*
CreateProject creates a project on the Dradis server and returns the newly created Project object. All 5 arguments are
required in the function call, but only name and clientId must be non-nil. reportTemplatePropertiesId is an optional int
that assigns a default report template to the project. authorIds accepts an int slice of authors to assign to the project.
template is an optional string that assigns the project template based on the template name.
gd := godradis.Godradis{}
[...]
authors := [2]int[]{3, 4}
project, _ := gd.CreateProject("New Project Name", 1, nil, authors[:], nil)
fmt.Printf("%v", project.Name)
*/
func (gd *Godradis) CreateProject(name string, clientId int, reportTemplatePropertiesId interface{}, authorIds []int, template interface{}) (Project, error) {
// Required so that json.Marshal() sends the project fields wrapped in a project{} json object
type reqModel struct {
Pd projectDetails `json:"project"`
}
pd := projectDetails{}
pd.parseArguments(name, clientId, reportTemplatePropertiesId, authorIds, template)
jsonBody, err := json.Marshal(&reqModel{pd})
if err != nil {
return Project{}, err
}
resp, err := gd.sendRequest("POST", "projects", jsonBody)
if err != nil {
return Project{}, err
}
defer resp.Body.Close()
var newProject Project
if resp.StatusCode != http.StatusCreated {
return Project{}, errors.New("could not create project")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Project{}, err
}
err = json.Unmarshal(body, &newProject)
if err != nil {
return Project{}, err
}
return newProject, nil
}
/*
UpdateProject takes a reference to an existing Project object as well as 5 arguments representing properties to update.
All arguments are required to be passed to UpdateProject but only properties being modified need to be non-nil. UpdateProject
modifies the original Project object in-place rather than returning a new one.
gd := godradis.Godradis{}
[...]
project, _ := gd.CreateProject("New Project Name", 1, nil, nil, nil)
err := gd.UpdateProject(&project, "Modified the project name", nil, nil, nil, nil)
if err != nil {
fmt.Printf("%v", project.Name)
}
*/
func (gd *Godradis) UpdateProject(p *Project, name, clientId, reportTemplatePropertiesId interface{}, authorIds []int, template interface{}) error {
// Required so that json.Marshal() sends the project fields wrapped in a project{} json object
type reqModel struct {
Pd projectDetails `json:"project"`
}
pd := projectDetails{}
pd.parseArguments(name, clientId, reportTemplatePropertiesId, authorIds, template)
jsonBody, err := json.Marshal(&reqModel{pd})
if err != nil {
return err
}
resp, err := gd.sendRequest("PUT", fmt.Sprintf("projects/%v", p.Id), jsonBody)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return errors.New("could not update project")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
err = json.Unmarshal(body, &p)
if err != nil {
return err
}
return nil
}
/*
DeleteProject takes a reference to a Project object and deletes the project on the Dradis server.
gd := godradis.Godradis{}
[...]
project, _ := gd.CreateProject("New Project Name", 1, nil, nil, nil)
err := gd.DeleteProject(&project)
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) DeleteProject(p *Project) error {
resp, err := gd.sendRequest("DELETE", fmt.Sprintf("projects/%v", p.Id), nil)
if err != nil {
return err
}
if resp.StatusCode == http.StatusOK {
return nil
} else {
return errors.New("could not delete project.")
}
}
// Teams endpoint
/*
GetAllTeams takes no arguments and returns a list of all teams on the server.
gd := godradis.Godradis{}
[...]
teamList, _ := gd.GetAllTeams()
if len(teamList) > 0 {
fmt.Printf("%v", teamList[0].Name)
}
*/
func (gd *Godradis) GetAllTeams() ([]Team, error) {
resp, err := gd.sendRequest("GET", "teams", nil)
if err != nil {
return []Team{}, err
}
defer resp.Body.Close()
var teams []Team
if resp.StatusCode != http.StatusOK {
return []Team{}, errors.New("could not get teams list")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return []Team{}, err
}
err = json.Unmarshal(body, &teams)
if err != nil {
return []Team{}, err
}
return teams, nil
}
/*
GetTeamById fetches a Team object from the Dradis server based on the int id.
gd := godradis.Godradis{}
[...]
team, err := gd.GetTeamById(2)
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) GetTeamById(id int) (Team, error) {
resp, err := gd.sendRequest("GET", fmt.Sprintf("teams/%v", id), nil)
if err != nil {
return Team{}, err
}
defer resp.Body.Close()
var team Team
if resp.StatusCode != http.StatusOK {
return Team{}, errors.New("could not get team")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Team{}, err
}
err = json.Unmarshal(body, &team)
if err != nil {
return Team{}, err
}
return team, nil
}
/*
GetTeamByName searches for and returns a Team object based on the name. GetTeamByName works by calling GetAllTeams
first and then ranges over them comparing the name strings.
gd := godradis.Godradis{}
[...]
team, err := gd.GetTeamByName("Test Client")
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) GetTeamByName(name string) (Team, error) {
teams, err := gd.GetAllTeams()
if err != nil {
return Team{}, err
}
for _, team := range teams {
if strings.ToLower(team.Name) == strings.ToLower(name) {
return team, nil
}
}
return Team{}, errors.New(fmt.Sprintf("could not find team with name %s", name))
}
type teamDetails struct {
Name string `json:"name,omitempty"`
TeamSince string `json:"team_since,omitempty"`
}
func (td *teamDetails) parseArguments(name, teamSince interface{}) {
if name == nil {
td.Name = ""
} else {
td.Name = name.(string)
}
if teamSince == nil {
td.TeamSince = ""
} else {
td.TeamSince = teamSince.(string)
}
}
/*
CreateTeam takes a name and optional teamSince (in the form "YYYY-MM-DD") string and creates a new Team on the server,
returning a new Team object. teamSince defaults to the current date if it's not passed as an argument.
gd := godradis.Godradis{}
[...]
team, _ := gd.CreateTeam("New Team", "2019-01-01")
otherTeam, _ := gd.CreateTeam("Other Team")
*/
func (gd *Godradis) CreateTeam(name string, teamSince ...string) (Team, error) {
// Required so that json.Marshal() sends the fields wrapped in a team{} json object
type reqModel struct {
TeamDetails teamDetails `json:"team"`
}
td := teamDetails{}
td.Name = name
if len(teamSince) > 0 {
td.TeamSince = teamSince[0]
}
jsonBody, err := json.Marshal(&reqModel{td})
if err != nil {
return Team{}, err
}
resp, err := gd.sendRequest("POST", "teams", jsonBody)
if err != nil {
return Team{}, err
}
defer resp.Body.Close()
var newTeam Team
if resp.StatusCode != http.StatusCreated {
return Team{}, errors.New("could not create team")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Team{}, err
}
err = json.Unmarshal(body, &newTeam)
if err != nil {
return Team{}, err
}
return newTeam, nil
}
/*
UpdateTeam takes a reference to an existing Team object and a name and teamSince (in the form "YYYY-MM-DD") string as
optional arguments. The Team argument is updated in-place.
gd := godradis.Godradis{}
[...]
team, _ := gd.GetTeamByName("Test Client")
err := gd.UpdateTeam(&team, nil, "2019-02-01")
*/
func (gd *Godradis) UpdateTeam(t *Team, name, teamSince interface{}) error {
// Required so that json.Marshal() sends the fields wrapped in a team{} json object
type reqModel struct {
TeamDetails teamDetails `json:"team"`
}
td := teamDetails{}
td.parseArguments(name, teamSince)
jsonBody, err := json.Marshal(&reqModel{td})
if err != nil {
return err
}
resp, err := gd.sendRequest("PUT", fmt.Sprintf("teams/%v", t.Id), jsonBody)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return errors.New("could not update team")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
err = json.Unmarshal(body, &t)
if err != nil {
return err
}
return nil
}
/*
DeleteTeam takes a reference to a Team object and deletes the team on the server.
gd := godradis.Godradis{}
[...]
team, _ := gd.CreateTeam("New Team", "2019-01-01")
err := gd.DeleteTeam(&team)
if err != nil {
fmt.Println(err)
}
*/
func (gd *Godradis) DeleteTeam(t *Team) error {
resp, err := gd.sendRequest("DELETE", fmt.Sprintf("teams/%v", t.Id), nil)
if err != nil {
return err
}
if resp.StatusCode == http.StatusOK {
return nil
} else {
return errors.New("could not delete team")
}
}
// Nodes endpoint
/*
GetAllNodes takes a reference to a Project object and returns a list of all Nodes that exist on the server for that project.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
nodes, _ := gd.GetAllNodes(&project)
*/
func (gd *Godradis) GetAllNodes(project *Project) ([]Node, error) {
resp, err := gd.sendRequestWithProjectId("GET", "nodes", project.Id, nil)
if err != nil {
return []Node{}, err
}
defer resp.Body.Close()
var nodes []Node
if resp.StatusCode != http.StatusOK {
return []Node{}, errors.New("could not get nodes list")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return []Node{}, err
}
err = json.Unmarshal(body, &nodes)
if err != nil {
return []Node{}, err
}
for i := 0; i < len(nodes); i++ {
nodes[i].Project = project
nodes[i].setEvidenceNodeReferences()
nodes[i].setNoteNodeReferences()
}
return nodes, nil
}
/*
GetNodeById takes a reference to a Project object and int id and returns the node associated with that id.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
node, _ := gd.GetNodeById(&project, 7)
*/
func (gd *Godradis) GetNodeById(project *Project, id int) (Node, error) {
resp, err := gd.sendRequestWithProjectId("GET", fmt.Sprintf("nodes/%v", id), project.Id, nil)
if err != nil {
return Node{}, err
}
defer resp.Body.Close()
var node Node
if resp.StatusCode != http.StatusOK {
return Node{}, errors.New("could not get node")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Node{}, err
}
err = json.Unmarshal(body, &node)
if err != nil {
return Node{}, err
}
node.Project = project
node.setEvidenceNodeReferences()
node.setNoteNodeReferences()
return node, nil
}
/*
GetNodeByLabel searches for and returns a Node object based on the label. GetNodeByLabel works by calling GetAllNodes
first and then ranges over them comparing the label strings.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
node, _ := gd.GetNodeByLabel(&project, "127.0.0.1")
*/
func (gd *Godradis) GetNodeByLabel(project *Project, label string) (Node, error) {
nodes, err := gd.GetAllNodes(project)
if err != nil {
return Node{}, err
}
for _, node := range nodes {
if strings.ToLower(node.Label) == strings.ToLower(label) {
return node, nil
}
}
return Node{}, errors.New(fmt.Sprintf("could not find node with label %s", label))
}
type nodeDetails struct {
Label string `json:"label,omitempty"`
TypeId int `json:"type_id,omitempty"`
ParentId int `json:"parent_id,omitempty"`
Position int `json:"position,omitempty"`
}
func (nd *nodeDetails) parseArguments(label, typeId, parentId, position interface{}) {
if label == nil {
nd.Label = ""
} else {
nd.Label = label.(string)
}
if typeId == nil {
nd.TypeId = 0
} else {
nd.TypeId = typeId.(int)
}
if parentId == nil {
nd.ParentId = 0
} else {
nd.ParentId = parentId.(int)
}
if position == nil {
nd.Position = 0
} else {
nd.Position = position.(int)
}
}
/*
CreateNode takes a reference to a Project object and several mandatory properties and creates a new Node on the server
and returns it. label is a string representing the name of the node. typeId is an int and can be 0 (a "default" node) or
1 (a "host" node). parentId is an int indicating the ID of the parent node if there is one, otherwise it will be created
as a top-level node. position is an int that determines where to insert the node within the existing node structure.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
node, _ := gd.CreateNode(&project, "127.0.0.1", 1, 14, 3)
*/
func (gd *Godradis) CreateNode(project *Project, label string, typeId int, parentId int, position int) (Node, error) {
// BUG(njfox): The parentId argument to CreateNode may not be correctly serialized in the API request
// Required so that json.Marshal() sends the fields wrapped in a node{} json object
type reqModel struct {
Node nodeDetails `json:"node"`
}
nd := nodeDetails{label, typeId, parentId, position}
jsonBody, err := json.Marshal(&reqModel{nd})
if err != nil {
return Node{}, err
}
resp, err := gd.sendRequestWithProjectId("POST", "nodes", project.Id, jsonBody)
if err != nil {
return Node{}, err
}
defer resp.Body.Close()
var newNode Node
if resp.StatusCode != http.StatusCreated {
return Node{}, errors.New("could not create node")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Node{}, err
}
err = json.Unmarshal(body, &newNode)
if err != nil {
return Node{}, err
}
newNode.Project = project
newNode.setEvidenceNodeReferences()
return newNode, nil
}
/*
UpdateNode takes a reference to an existing Node object and updates any non-nil properties passed to it as arguments.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
node, _ := gd.GetNodeByLabel(&project, "127.0.0.1")
_ := gd.UpdateNode(&node, "localhost", nil, nil, nil)
*/
func (gd *Godradis) UpdateNode(n *Node, label, typeId, parentId, position interface{}) error {
// Required so that json.Marshal() sends the fields wrapped in a node{} json object
type reqModel struct {
NodeDetails nodeDetails `json:"node"`
}
nd := nodeDetails{}
nd.parseArguments(label, typeId, parentId, position)
jsonBody, err := json.Marshal(&reqModel{nd})
if err != nil {
return err
}
resp, err := gd.sendRequestWithProjectId("PUT", fmt.Sprintf("nodes/%v", n.Id), n.Project.Id, jsonBody)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return errors.New("could not update node")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
err = json.Unmarshal(body, &n)
if err != nil {
return err
}
return nil
}
/*
DeleteNode takes a reference to an existing Node object and deletes it on the server.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
node, _ := gd.GetNodeByLabel(&project, "127.0.0.1")
_ := gd.DeleteNode(&node)
*/
func (gd *Godradis) DeleteNode(n *Node) error {
resp, err := gd.sendRequestWithProjectId("DELETE", fmt.Sprintf("nodes/%v", n.Id), n.Project.Id, nil)
if err != nil {
return err
}
if resp.StatusCode == http.StatusOK {
return nil
} else {
return errors.New("could not delete node")
}
}
// Issues endpoint
/*
GetAllIssues takes a reference to a Project object and returns a list of all Issues that exist on the server for that project.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
issues, _ := gd.GetAllIssues(&project)
*/
func (gd *Godradis) GetAllIssues(project *Project) ([]Issue, error) {
resp, err := gd.sendRequestWithProjectId("GET", "issues", project.Id, nil)
if err != nil {
return []Issue{}, err
}
defer resp.Body.Close()
var issues []Issue
if resp.StatusCode != http.StatusOK {
return []Issue{}, errors.New("could not get issue list")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return []Issue{}, err
}
err = json.Unmarshal(body, &issues)
if err != nil {
return []Issue{}, err
}
for i := 0; i < len(issues); i++ {
issues[i].Project = project
}
return issues, nil
}
/*
GetIssueById takes a reference to a Project object and int id and returns the Issue associated with that id.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
issue, _ := gd.GetIssueById(&project, 12)
*/
func (gd *Godradis) GetIssueById(project *Project, id int) (Issue, error) {
resp, err := gd.sendRequestWithProjectId("GET", fmt.Sprintf("issues/%v", id), project.Id, nil)
if err != nil {
return Issue{}, err
}
defer resp.Body.Close()
var issue Issue
if resp.StatusCode != http.StatusOK {
return Issue{}, errors.New("could not get issue")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Issue{}, err
}
err = json.Unmarshal(body, &issue)
if err != nil {
return Issue{}, err
}
issue.Project = project
return issue, nil
}
/*
GetIssueByTitle searches for and returns an Issue object based on the title. GetIssueByTitle works by calling GetAllIssues
first and then ranges over them comparing the title strings.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
issue, _ := gd.GetIssueByTitle(&project, "Cross-Site Scripting")
*/
func (gd *Godradis) GetIssueByTitle(project *Project, title string) (Issue, error) {
issues, err := gd.GetAllIssues(project)
if err != nil {
return Issue{}, err
}
for _, issue := range issues {
if strings.ToLower(issue.Title) == strings.ToLower(title) {
return issue, nil
}
}
return Issue{}, errors.New(fmt.Sprintf("could not find issue with title %s", title))
}
/*
CreateIssue takes a reference to a Project object and an OrderedMap containing the fields in the Issue body, creates a
new Issue on the server, and returns it.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
fields := orderedmap.New()
fields.Set("Title", "Insecure Password Storage")
fields.Set("Severity", "High")
fields.Set("Finding Information", "Lorem ipsum dolor sit amet")
issue, _ := gd.CreateIssue(&project, fields)
*/
func (gd *Godradis) CreateIssue(project *Project, fields *orderedmap.OrderedMap) (Issue, error) {
text := parseOrderedMapFields(fields)
issue, err := gd.CreateIssueFromText(project, text)
if err != nil {
return Issue{}, err
}
issue.Project = project
return issue, nil
}
/*
CreateIssueFromText provides an alternate method for creating issues directly from a text string as opposed to the
OrderedMap approach used by CreateIssue. CreateIssueFromText takes a reference to a Project object and a string containing
the raw body content and returns the newly created Issue.
gd := godradis.Godradis{}
[...]
project, _ := gd.GetProjectByName("Foobar External Network Penetration Test")
issue, _ = gd.CreateIssueFromText(&project, "#[Title]#\r\nInsecure Password Storage\r\n\r\n#[Severity]#\r\nHigh")
*/
func (gd *Godradis) CreateIssueFromText(project *Project, text string) (Issue, error) {
// Required so that json.Marshal() sends the fields wrapped in a issue{} json object
type issueDetails struct {
Text string `json:"text"`
}
type reqModel struct {
IssueDetails issueDetails `json:"issue"`
}
jsonBody, err := json.Marshal(&reqModel{issueDetails{text}})
if err != nil {
return Issue{}, err
}
resp, err := gd.sendRequestWithProjectId("POST", "issues", project.Id, jsonBody)
if err != nil {
return Issue{}, err
}
defer resp.Body.Close()
var newIssue Issue
if resp.StatusCode != http.StatusCreated {
return Issue{}, errors.New("could not create issue")
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return Issue{}, err
}