-
Notifications
You must be signed in to change notification settings - Fork 61
Expand file tree
/
Copy pathmain.go
More file actions
748 lines (731 loc) · 26.8 KB
/
main.go
File metadata and controls
748 lines (731 loc) · 26.8 KB
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
package main
import (
"crypto/rsa"
"crypto/tls"
"fmt"
"net/http"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/crewjam/saml/samlsp"
"github.com/jmpsec/osctrl/cmd/admin/handlers"
"github.com/jmpsec/osctrl/cmd/admin/sessions"
"github.com/jmpsec/osctrl/pkg/auditlog"
"github.com/jmpsec/osctrl/pkg/backend"
"github.com/jmpsec/osctrl/pkg/cache"
"github.com/jmpsec/osctrl/pkg/carves"
"github.com/jmpsec/osctrl/pkg/config"
"github.com/jmpsec/osctrl/pkg/environments"
"github.com/jmpsec/osctrl/pkg/logging"
"github.com/jmpsec/osctrl/pkg/nodes"
"github.com/jmpsec/osctrl/pkg/queries"
"github.com/jmpsec/osctrl/pkg/settings"
"github.com/jmpsec/osctrl/pkg/tags"
"github.com/jmpsec/osctrl/pkg/types"
"github.com/jmpsec/osctrl/pkg/users"
"github.com/jmpsec/osctrl/pkg/version"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/spf13/viper"
"github.com/urfave/cli/v2"
)
// Constants for the service
const (
// Project name
projectName string = "osctrl"
// Service name
serviceName string = projectName + "-" + config.ServiceAdmin
// Service description
serviceDescription string = "Admin service for osctrl"
// Application description
appDescription string = serviceDescription + ", a fast and efficient osquery management"
)
// Paths
const (
// Default endpoint to handle HTTP health
healthPath string = "/health"
// Default endpoint to handle Login
loginPath string = "/login"
// Default endpoint to handle Logout
logoutPath string = "/logout"
// Default endpoint to handle HTTP(500) errors
errorPath string = "/error"
// Default endpoint to handle Forbidden(403) errors
forbiddenPath string = "/forbidden"
// Default endpoint for favicon
faviconPath string = "/favicon.ico"
)
// Random
const (
// Default refreshing interval in seconds
defaultRefresh int = 300
// Default interval in seconds to expire queries/carves
defaultExpiration int = 900
// Default hours to classify nodes as inactive
defaultInactive int = 72
)
// Build-time metadata (overridden via -ldflags "-X main.buildVersion=... -X main.buildCommit=... -X main.buildDate=...")
var (
buildVersion = version.OsctrlVersion
buildCommit = "unknown"
buildDate = "unknown"
)
// Global general variables
var (
err error
db *backend.DBManager
redis *cache.RedisManager
settingsmgr *settings.Settings
nodesmgr *nodes.NodeManager
queriesmgr *queries.Queries
carvesmgr *carves.Carves
sessionsmgr *sessions.SessionManager
envs *environments.EnvManager
adminUsers *users.UserManager
tagsmgr *tags.TagManager
carvers3 *carves.CarverS3
app *cli.App
flags []cli.Flag
flagParams config.ServiceFlagParams
// FIXME this is nasty and should not be a global but here we are
osqueryTables []types.OsqueryTable
handlersAdmin *handlers.HandlersAdmin
auditLog *auditlog.AuditLogManager
)
// SAML variables
var (
samlMiddleware *samlsp.Middleware
samlConfig JSONConfigurationSAML
samlData samlThings
)
// Valid values for auth in configuration
var validAuth = map[string]bool{
config.AuthDB: true,
config.AuthSAML: true,
config.AuthJSON: true,
}
// Valid values for carver in configuration
var validCarver = map[string]bool{
config.CarverDB: true,
config.CarverLocal: true,
config.CarverS3: true,
}
// Function to load the configuration file
func loadConfiguration(file, service string) (config.JSONConfigurationService, error) {
var cfg config.JSONConfigurationService
log.Info().Msgf("Loading %s", file)
// Load file and read config
viper.SetConfigFile(file)
if err := viper.ReadInConfig(); err != nil {
return cfg, err
}
// Admin values
adminRaw := viper.Sub(service)
if adminRaw == nil {
return cfg, fmt.Errorf("JSON key %s not found in file %s", service, file)
}
if err := adminRaw.Unmarshal(&cfg); err != nil {
return cfg, err
}
// Check if values are valid
if !validAuth[cfg.Auth] {
return cfg, fmt.Errorf("invalid auth method")
}
if !validCarver[cfg.Carver] {
return cfg, fmt.Errorf("invalid carver method")
}
// No errors!
return cfg, nil
}
// Function to load the configuration from a single YAML file
/*func loadConfigurationYAML(file string) (config.AdminConfiguration, error) {
var cfg config.AdminConfiguration
// Load file and read config
viper.SetConfigFile(file)
viper.SetConfigType("yaml")
if err := viper.ReadInConfig(); err != nil {
return cfg, err
}
// No errors!
return cfg, nil
}*/
// Initialization code
func init() {
// Initialize CLI flags using the config package
flags = config.InitAdminFlags(&flagParams)
}
// Go go!
func osctrlAdminService() {
// ////////////////////////////// Backend
log.Info().Msg("Initializing backend...")
for {
db, err = backend.CreateDBManager(flagParams.DBConfigValues)
if db != nil {
log.Info().Msg("Connection to backend successful!")
break
}
if err != nil {
log.Err(err).Msg("Failed to connect to backend")
if flagParams.DBConfigValues.ConnRetry == 0 {
log.Fatal().Msg("Connection to backend failed and no retry was set")
}
}
log.Debug().Msgf("Backend NOT ready! Retrying in %d seconds...\n", flagParams.DBConfigValues.ConnRetry)
time.Sleep(time.Duration(flagParams.DBConfigValues.ConnRetry) * time.Second)
}
// ////////////////////////////// Cache
log.Info().Msg("Initializing cache...")
for {
redis, err = cache.CreateRedisManager(flagParams.RedisConfigValues)
if redis != nil {
log.Info().Msg("Connection to cache successful!")
break
}
if err != nil {
log.Err(err).Msg("Failed to connect to cache")
if flagParams.RedisConfigValues.ConnRetry == 0 {
log.Fatal().Msg("Connection to cache failed and no retry was set")
}
}
log.Debug().Msgf("Cache NOT ready! Retrying in %d seconds...\n", flagParams.RedisConfigValues.ConnRetry)
time.Sleep(time.Duration(flagParams.RedisConfigValues.ConnRetry) * time.Second)
}
log.Info().Msg("Initialize users")
adminUsers = users.CreateUserManager(db.Conn, &flagParams.JWTConfigValues)
log.Info().Msg("Initialize tags")
tagsmgr = tags.CreateTagManager(db.Conn)
log.Info().Msg("Initialize environments")
envs = environments.CreateEnvironment(db.Conn)
log.Info().Msg("Initialize settings")
settingsmgr = settings.NewSettings(db.Conn)
log.Info().Msg("Initialize nodes")
nodesmgr = nodes.CreateNodes(db.Conn)
log.Info().Msg("Initialize queries")
queriesmgr = queries.CreateQueries(db.Conn)
log.Info().Msg("Initialize carves")
carvesmgr = carves.CreateFileCarves(db.Conn, flagParams.ConfigValues.Carver, carvers3)
log.Info().Msg("Initialize sessions")
sessionsmgr = sessions.CreateSessionManager(db.Conn, authCookieName, flagParams.ConfigValues.SessionKey)
log.Info().Msg("Loading service settings")
if err := loadingSettings(settingsmgr, flagParams.ConfigValues); err != nil {
log.Fatal().Msgf("Error loading settings - %v", err)
}
// Start SAML Middleware if we are using SAML
if flagParams.ConfigValues.Auth == config.AuthSAML {
log.Debug().Msg("SAML enabled for authentication")
// Initialize SAML keypair to sign SAML Request.
var err error
samlData, err = keypairSAML(samlConfig)
if err != nil {
log.Fatal().Msgf("Can not initialize SAML keypair %s", err)
}
samlMiddleware, err = samlsp.New(samlsp.Options{
URL: *samlData.RootURL,
Key: samlData.KeyPair.PrivateKey.(*rsa.PrivateKey),
Certificate: samlData.KeyPair.Leaf,
IDPMetadata: samlData.IdpMetadata,
AllowIDPInitiated: true,
})
if err != nil {
log.Fatal().Msgf("Can not initialize SAML Middleware %s", err)
}
}
// FIXME Redis cache - Ticker to cleanup sessions
// FIXME splay this?
log.Info().Msg("Initialize cleanup sessions")
go func() {
_t := settingsmgr.CleanupSessions()
if _t == 0 {
_t = int64(defaultRefresh)
}
for {
log.Debug().Msg("Cleaning up sessions")
sessionsmgr.Cleanup()
time.Sleep(time.Duration(_t) * time.Second)
}
}()
// Goroutine to cleanup expired queries and carves
log.Info().Msg("Initialize cleanup queries/carves")
go func() {
_t := settingsmgr.CleanupExpired()
if _t == 0 {
_t = int64(defaultExpiration)
}
for {
log.Debug().Msg("Cleaning up expired queries/carves")
allEnvs, err := envs.All()
if err != nil {
log.Err(err).Msg("Error getting all environments")
}
for _, e := range allEnvs {
// Periotically check if the queries are completed
// not sure if we need to complete the Carves
if err := queriesmgr.CleanupCompletedQueries(e.ID); err != nil {
log.Err(err).Msg("Error completing expired queries")
}
// Periotically check if the queries are expired
if err := queriesmgr.CleanupExpiredQueries(e.ID); err != nil {
log.Err(err).Msg("Error cleaning up expired queries")
}
if err := queriesmgr.CleanupExpiredCarves(e.ID); err != nil {
log.Err(err).Msg("Error cleaning up expired carves")
}
}
time.Sleep(time.Duration(_t) * time.Second)
}
}()
var loggerDBConfig *backend.JSONConfigurationDB
// Set the logger configuration file if we have a DB logger
if flagParams.ConfigValues.Logger == config.LoggingDB {
if flagParams.LoggerDBSame {
flagParams.LoggerFile = ""
loggerDBConfig = &flagParams.DBConfigValues
}
}
// Initialize audit log manager
if flagParams.AuditLog {
log.Info().Msg("Initialize audit log (enabled)")
} else {
log.Info().Msg("Initialize audit log (disabled)")
}
auditLog, err = auditlog.CreateAuditLogManager(db.Conn, serviceName, flagParams.AuditLog)
if err != nil {
log.Fatal().Msgf("Error initializing audit log manager - %v", err)
}
// Initialize Admin handlers before router
log.Info().Msg("Initializing handlers")
handlersAdmin = handlers.CreateHandlersAdmin(
handlers.WithDB(db.Conn),
handlers.WithEnvs(envs),
handlers.WithUsers(adminUsers),
handlers.WithTags(tagsmgr),
handlers.WithNodes(nodesmgr),
handlers.WithQueries(queriesmgr),
handlers.WithCarves(carvesmgr),
handlers.WithSettings(settingsmgr),
handlers.WithCache(redis),
handlers.WithSessions(sessionsmgr),
handlers.WithMetadata(types.BuildMetadata{
Version: buildVersion,
Commit: buildCommit,
Date: buildDate,
}),
handlers.WithOsqueryValues(flagParams.OsqueryConfigValues),
handlers.WithTemplates(flagParams.TemplatesDir),
handlers.WithStaticLocation(flagParams.StaticOffline),
handlers.WithOsqueryTables(osqueryTables),
handlers.WithCarvesFolder(flagParams.CarvedDir),
handlers.WithOptimizedUI(flagParams.OptimizeUI),
handlers.WithAdminConfig(&flagParams.ConfigValues),
handlers.WithAuditLog(auditLog),
handlers.WithDBLogger(flagParams.LoggerFile, loggerDBConfig),
handlers.WithDebugHTTP(&flagParams.DebugHTTPValues),
)
// ////////////////////////// ADMIN
log.Info().Msg("Initializing router")
// Create router for admin
adminMux := http.NewServeMux()
// ///////////////////////// UNAUTHENTICATED CONTENT
// Admin: login only if local auth is enabled
if flagParams.ConfigValues.Auth != config.AuthNone && flagParams.ConfigValues.Auth != config.AuthSAML {
// login
adminMux.HandleFunc("GET "+loginPath, handlersAdmin.LoginHandler)
adminMux.HandleFunc("POST "+loginPath, handlersAdmin.LoginPOSTHandler)
adminMux.HandleFunc("GET "+logoutPath, func(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, loginPath, http.StatusFound)
})
}
// Admin: health of service
adminMux.HandleFunc("GET "+healthPath, handlersAdmin.HealthHandler)
// Admin: error
adminMux.HandleFunc("GET "+errorPath, handlersAdmin.ErrorHandler)
// Admin: forbidden
adminMux.HandleFunc("GET "+forbiddenPath, handlersAdmin.ForbiddenHandler)
// Admin: favicon
adminMux.HandleFunc("GET "+faviconPath, handlersAdmin.FaviconHandler)
// Admin: static
adminMux.Handle("GET /static/", http.StripPrefix("/static", http.FileServer(http.Dir(flagParams.StaticFiles))))
// Admin: background image
adminMux.HandleFunc("GET /background-image", func(w http.ResponseWriter, r *http.Request) {
http.ServeFile(w, r, flagParams.BackgroundImage)
})
// ///////////////////////// AUTHENTICATED CONTENT
// Admin: branding image
adminMux.Handle(
"GET /branding-image",
handlerAuthCheck(
http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
http.ServeFile(w, r, flagParams.BrandingImage)
}),
flagParams.ConfigValues.Auth,
),
)
// Admin: JSON data for environments
adminMux.Handle(
"GET /json/environment/{env}/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONEnvironmentHandler), flagParams.ConfigValues.Auth))
// Admin: paginated JSON data for environments
if flagParams.OptimizeUI {
adminMux.Handle(
"GET /paginated-json/environment/{env}/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONEnvironmentPagingHandler), flagParams.ConfigValues.Auth))
}
// Admin: JSON data for logs
adminMux.Handle(
"GET /json/logs/{type}/{env}/{uuid}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONLogsHandler), flagParams.ConfigValues.Auth))
// Admin: JSON data for query logs
adminMux.Handle(
"GET /json/query/{env}/{name}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONQueryLogsHandler), flagParams.ConfigValues.Auth))
if flagParams.OptimizeUI {
adminMux.Handle(
"GET /json-download/query/{env}/{name}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONDownloadQueryLogsHandler), flagParams.ConfigValues.Auth))
}
// Admin: JSON data for sidebar stats
adminMux.Handle(
"GET /json/stats/{target}/{identifier}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONStatsHandler), flagParams.ConfigValues.Auth))
// Admin: JSON data for tags
adminMux.Handle(
"GET /json/tags",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONTagsHandler), flagParams.ConfigValues.Auth))
// Admin: JSON data for audit logs
if flagParams.AuditLog {
adminMux.Handle(
"GET /json/audit-logs",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONAuditLogHandler), flagParams.ConfigValues.Auth))
}
// Admin: table for environments
adminMux.Handle(
"GET /environment/{env}/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnvironmentHandler), flagParams.ConfigValues.Auth))
// Admin: root
adminMux.Handle(
"GET /",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.RootHandler), flagParams.ConfigValues.Auth))
// Admin: node view
adminMux.Handle(
"GET /node/{uuid}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.NodeHandler), flagParams.ConfigValues.Auth))
// Admin: multi node action
adminMux.Handle(
"POST /node/actions",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.NodeActionsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: run queries
adminMux.Handle(
"GET /query/{env}/run",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.QueryRunGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /query/{env}/run",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.QueryRunPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: list queries
adminMux.Handle(
"GET /query/{env}/list",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.QueryListGETHandler), flagParams.ConfigValues.Auth))
// Admin: saved queries
adminMux.Handle(
"GET /query/{env}/saved",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.SavedQueriesGETHandler), flagParams.ConfigValues.Auth))
// Admin: query actions
adminMux.Handle(
"POST /query/{env}/actions",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.QueryActionsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: query JSON
adminMux.Handle(
"GET /query/{env}/json/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONQueryHandler), flagParams.ConfigValues.Auth))
// Admin: query logs
adminMux.Handle(
"GET /query/{env}/logs/{name}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.QueryLogsHandler), flagParams.ConfigValues.Auth))
// Admin: carve files
adminMux.Handle(
"GET /carves/{env}/run",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesRunGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /carves/{env}/run",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesRunPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: list carves
adminMux.Handle(
"GET /carves/{env}/list",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesListGETHandler), flagParams.ConfigValues.Auth))
// Admin: carves actions
adminMux.Handle(
"POST /carves/{env}/actions",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesActionsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: carves JSON
adminMux.Handle(
"GET /carves/{env}/json/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.JSONCarvesHandler), flagParams.ConfigValues.Auth))
// Admin: carves details
adminMux.Handle(
"GET /carves/{env}/details/{name}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesDetailsHandler), flagParams.ConfigValues.Auth))
// Admin: carves download
adminMux.Handle(
"GET /carves/{env}/download/{sessionid}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.CarvesDownloadHandler), flagParams.ConfigValues.Auth))
// Admin: nodes configuration
adminMux.Handle(
"GET /conf/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.ConfGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /conf/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.ConfPOSTHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /intervals/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.IntervalsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: nodes enroll
adminMux.Handle(
"GET /enroll/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnrollGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /enroll/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnrollPOSTHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"GET /enroll/{env}/download/{target}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnrollDownloadHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /expiration/{env}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.ExpirationPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: server settings
adminMux.Handle(
"GET /settings/{service}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.SettingsGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /settings/{service}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.SettingsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: manage environments
adminMux.Handle(
"GET /environments",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnvsGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /environments",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EnvsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: manage users
adminMux.Handle(
"GET /users",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.UsersGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /users",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.UsersPOSTHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"GET /users/permissions/{username}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.PermissionsGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /users/permissions/{username}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.PermissionsPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: manage tags
adminMux.Handle(
"GET /tags",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.TagsGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /tags",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.TagsPOSTHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /tags/nodes",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.TagNodesPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: manage tokens
adminMux.Handle(
"GET /tokens/{username}",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.TokensGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /tokens/{username}/refresh",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.TokensPOSTHandler), flagParams.ConfigValues.Auth))
// Admin: edit profile
adminMux.Handle(
"GET /profile",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EditProfileGETHandler), flagParams.ConfigValues.Auth))
adminMux.Handle(
"POST /profile",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.EditProfilePOSTHandler), flagParams.ConfigValues.Auth))
// Admin: audit logs
if flagParams.AuditLog {
adminMux.Handle(
"GET /audit-logs",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.AuditLogsGETHandler), flagParams.ConfigValues.Auth))
}
// Admin: dashboard and search bar
adminMux.Handle(
"GET /dashboard",
handlerAuthCheck(http.HandlerFunc(handlersAdmin.DashboardGETHandler), flagParams.ConfigValues.Auth))
// Admin: logout
adminMux.Handle(
"POST "+logoutPath,
handlerAuthCheck(http.HandlerFunc(handlersAdmin.LogoutPOSTHandler), flagParams.ConfigValues.Auth))
// SAML ACS
if flagParams.ConfigValues.Auth == config.AuthSAML {
adminMux.Handle("GET /saml/acs", samlMiddleware)
adminMux.Handle("POST /saml/acs", samlMiddleware)
adminMux.Handle("GET /saml/metadata", samlMiddleware)
adminMux.Handle("POST /saml/metadata", samlMiddleware)
adminMux.HandleFunc("GET "+loginPath, func(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, samlConfig.LoginURL, http.StatusFound)
})
adminMux.HandleFunc("GET "+logoutPath, func(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, samlConfig.LogoutURL, http.StatusFound)
})
}
// Launch HTTP server for admin
serviceListener := flagParams.ConfigValues.Listener + ":" + flagParams.ConfigValues.Port
if flagParams.TLSServer {
cfg := &tls.Config{
MinVersion: tls.VersionTLS12,
CurvePreferences: []tls.CurveID{tls.CurveP521, tls.CurveP384, tls.CurveP256},
PreferServerCipherSuites: true,
CipherSuites: []uint16{
tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
tls.TLS_RSA_WITH_AES_256_CBC_SHA,
},
}
srv := &http.Server{
Addr: serviceListener,
Handler: adminMux,
TLSConfig: cfg,
TLSNextProto: make(map[string]func(*http.Server, *tls.Conn, http.Handler), 0),
}
log.Info().Msgf("%s v%s - HTTPS listening %s", serviceName, buildVersion, serviceListener)
log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
if err := srv.ListenAndServeTLS(flagParams.TLSCertFile, flagParams.TLSKeyFile); err != nil {
log.Fatal().Msgf("ListenAndServeTLS: %v", err)
}
} else {
log.Info().Msgf("%s v%s - HTTP listening %s", serviceName, buildVersion, serviceListener)
log.Info().Msgf("%s - commit=%s - build date=%s", serviceName, buildCommit, buildDate)
if err := http.ListenAndServe(serviceListener, adminMux); err != nil {
log.Fatal().Msgf("ListenAndServe: %v", err)
}
}
}
// Action to run when no flags are provided to run checks and prepare data
func cliAction(c *cli.Context) error {
// Load configuration if external JSON config file is used
if flagParams.ConfigFlag {
flagParams.ConfigValues, err = loadConfiguration(flagParams.ServiceConfigFile, config.ServiceAdmin)
if err != nil {
return fmt.Errorf("failed to load service configuration %s - %w", flagParams.ServiceConfigFile, err)
}
}
// Load redis configuration if external JSON config file is used
if flagParams.RedisFlag {
flagParams.RedisConfigValues, err = cache.LoadConfiguration(flagParams.RedisConfigFile, cache.RedisKey)
if err != nil {
return fmt.Errorf("failed to load redis configuration - %w", err)
}
}
// Load DB configuration if external JSON config file is used
if flagParams.DBFlag {
flagParams.DBConfigValues, err = backend.LoadConfiguration(flagParams.DBConfigFile, backend.DBKey)
if err != nil {
return fmt.Errorf("failed to load DB configuration - %w", err)
}
}
// Load SAML configuration if this authentication is used in the service config
if flagParams.ConfigValues.Auth == config.AuthSAML {
samlConfig, err = loadSAML(flagParams.SAMLConfigFile)
if err != nil {
return fmt.Errorf("failed to load SAML configuration - %w", err)
}
}
// Load JWT configuration if external JWT JSON config file is used
if flagParams.JWTFlag {
flagParams.JWTConfigValues, err = loadJWTConfiguration(flagParams.JWTConfigFile)
if err != nil {
return fmt.Errorf("failed to load JWT configuration - %w", err)
}
}
// Load osquery tables JSON file
osqueryTables, err = loadOsqueryTables(flagParams.OsqueryConfigValues.TablesFile)
if err != nil {
return fmt.Errorf("failed to load osquery tables - %w", err)
}
// Load carver configuration if external JSON config file is used
if flagParams.ConfigValues.Carver == config.CarverS3 {
if flagParams.S3CarverConfig.Bucket != "" {
carvers3, err = carves.CreateCarverS3(flagParams.S3CarverConfig)
} else {
carvers3, err = carves.CreateCarverS3File(flagParams.CarverConfigFile)
}
if err != nil {
return fmt.Errorf("failed to initiate s3 carver - %w", err)
}
}
return nil
}
func initializeLoggers(cfg config.JSONConfigurationService) {
// Set the log level
switch strings.ToLower(cfg.LogLevel) {
case config.LogLevelDebug:
zerolog.SetGlobalLevel(zerolog.DebugLevel)
case config.LogLevelInfo:
zerolog.SetGlobalLevel(zerolog.InfoLevel)
case config.LogLevelWarn:
zerolog.SetGlobalLevel(zerolog.WarnLevel)
case config.LogLevelError:
zerolog.SetGlobalLevel(zerolog.ErrorLevel)
default:
zerolog.SetGlobalLevel(zerolog.InfoLevel)
}
// Set the log format
switch strings.ToLower(cfg.LogFormat) {
case config.LogFormatJSON:
log.Logger = log.With().Caller().Logger()
case config.LogFormatConsole:
zerolog.CallerMarshalFunc = func(pc uintptr, file string, line int) string {
return filepath.Base(file) + ":" + strconv.Itoa(line)
}
log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: logging.LoggerTimeFormat}).With().Caller().Logger()
default:
log.Logger = log.With().Caller().Logger()
}
}
func main() {
// Initiate CLI and parse arguments
app = cli.NewApp()
app.Name = serviceName
app.Usage = appDescription
app.Version = buildVersion
app.Description = appDescription
app.Flags = flags
// Customize version output (supports `--version` and `version` command)
cli.VersionPrinter = func(c *cli.Context) {
fmt.Printf("%s version=%s commit=%s date=%s\n", serviceName, buildVersion, buildCommit, buildDate)
}
// Add -v alias to the global --version flag
cli.VersionFlag = &cli.BoolFlag{
Name: "version",
Aliases: []string{"v"},
Usage: "Print version information",
}
// Define this command for help to exit when help flag is passed
app.Commands = []*cli.Command{
{
Name: "help",
Action: func(c *cli.Context) error {
cli.ShowAppHelpAndExit(c, 0)
return nil
},
},
}
// Start service only for default action; version/help won't trigger this
app.Action = func(c *cli.Context) error {
if err := cliAction(c); err != nil {
return err
}
// Initialize service logger
initializeLoggers(flagParams.ConfigValues)
// Service starts!
osctrlAdminService()
return nil
}
if err := app.Run(os.Args); err != nil {
fmt.Printf("app.Run error: %s", err.Error())
os.Exit(1)
}
}