forked from EmissarySocial/emissary
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.go
467 lines (377 loc) · 17.1 KB
/
server.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
/*
Package main is the entry point for the application. It reads the server
configuration info, initializes the server.Factory, wires up routes to
the appropriate handlers, then starts the HTTP/HTTPS server.
*/
package main
import (
"context"
"embed"
"fmt"
"html/template"
"io/fs"
"net/http"
"net/url"
"os"
"os/signal"
"time"
"github.com/EmissarySocial/emissary/config"
"github.com/EmissarySocial/emissary/handler"
ap_stream "github.com/EmissarySocial/emissary/handler/activitypub_stream"
ap_user "github.com/EmissarySocial/emissary/handler/activitypub_user"
mw "github.com/EmissarySocial/emissary/middleware"
"github.com/EmissarySocial/emissary/server"
"github.com/benpate/derp"
"github.com/benpate/domain"
"github.com/benpate/hannibal/vocab"
"github.com/benpate/rosetta/slice"
"github.com/benpate/steranko"
toot "github.com/benpate/toot-echo"
"github.com/davecgh/go-spew/spew"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
gommonlog "github.com/labstack/gommon/log"
"github.com/pkg/browser"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"golang.org/x/crypto/acme/autocert"
)
//go:embed all:_embed/**
var embeddedFiles embed.FS
/******************************************
* Main Application Entry Point
******************************************/
func main() {
fmt.Println(" _____ _ ")
fmt.Println("| ____|_ __ ___ (_)___ ___ __ _ _ __ _ _ ")
fmt.Println("| _| | '_ ` _ \\| / __/ __|/ _` | '__| | | |")
fmt.Println("| |___| | | | | | \\__ \\__ \\ (_| | | | |_| |")
fmt.Println("|_____|_| |_| |_|_|___/___/\\__,_|_| \\__, |")
fmt.Println(" |___/ ")
fmt.Println("")
go waitForSigInt()
// Troubleshoot / Error Reporting
spew.Config.DisableMethods = true
spew.Config.Indent = " "
// Logging Configuration
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
log.Logger = log.Output(zerolog.ConsoleWriter{
Out: os.Stderr,
NoColor: true,
TimeFormat: "",
})
// Locate the configuration file and populate the server factory
commandLineArgs := config.GetCommandLineArgs()
configStorage := config.Load(&commandLineArgs)
factory := server.NewFactory(configStorage, embeddedFiles)
// Wait for the first time the configuration is loaded
<-factory.Refreshed()
// Start and configure the Web server
e := echo.New()
e.Logger.SetLevel(gommonlog.OFF)
e.HideBanner = true
e.HidePort = true
e.HTTPErrorHandler = errorHandler
// Global middleware
// TODO: HIGH: Implement echo.Secure - https://echo.labstack.com/docs/middleware/secure
// TODO: HIGH: Implement CSRF protection - https://echo.labstack.com/docs/middleware/csrf
// TODO: MEDIUM: Implement Rate Limiter - https://echo.labstack.com/docs/middleware/rate-limiter
// TODO: LOW: Implement Timeout - https://echo.labstack.com/docs/middleware/timeout
// TODO: LOW: Implement GZip - https://echo.labstack.com/docs/middleware/gzip
e.Use(middleware.Recover())
if commandLineArgs.Setup {
// Get config modifiers from the command line (like HTTP PORT)
configOptions := commandLineArgs.ConfigOptions()
// Add routes for setup tool
makeSetupRoutes(factory, e)
// When running the setup tool, wait a second, then open a browser window to the correct URL
openLocalhostBrowser(factory, configOptions...)
// Prepare HTTP and HTTPS servers using the new configuration
go startHTTP(factory, e, configOptions...)
} else {
// Add routes for standard web server
makeStandardRoutes(factory, e)
// Prepare HTTP and HTTPS servers using the new configuration
go startHTTP(factory, e)
go startHTTPS(factory, e)
}
// Listen to the OS SIGINT channel for an interrupt signal
// Use a buffered channel to avoid missing signals as recommended for signal.Notify
// https://golang.org/pkg/os/signal/#Notify
quit := make(chan os.Signal, 1)
signal.Notify(quit, os.Interrupt)
loop:
for {
select {
// Collect configuration refresh events (probably don't need to do anything, though)
case <-factory.Refreshed():
// If we get a SIGINT, then shutdown gracefully
case <-quit:
gracefulShutdown(e)
break loop
}
}
}
/******************************************
* Routes for Different Application Modes
******************************************/
// makeSetupRoutes generates a new Echo instance for the setup behavior
func makeSetupRoutes(factory *server.Factory, e *echo.Echo) {
log.Info().Msg("Starting Emissary Setup Console")
// Locate the setup templates
setupFiles, err := fs.Sub(embeddedFiles, "_embed/setup")
if err != nil {
panic("Unable to open embedded files for setup. " + err.Error())
}
setupTemplates := template.Must(template.New("").
Funcs(factory.FuncMap()).
ParseFS(setupFiles, "*.html"))
// Middleware for setup pages
e.Use(mw.Localhost())
// Setup Routes
e.GET("/", handler.SetupPageGet(factory, setupTemplates, "index.html"))
e.GET("/server", handler.SetupPageGet(factory, setupTemplates, "server.html"))
e.POST("/server", handler.SetupServerPost(factory))
e.GET("/server/:section", handler.SetupServerGet(factory))
e.POST("/server/:section", handler.SetupServerPost(factory))
e.GET("/domains", handler.SetupPageGet(factory, setupTemplates, "domains.html"))
e.GET("/domains/:domain", handler.SetupDomainGet(factory))
e.POST("/domains/:domain", handler.SetupDomainPost(factory))
e.DELETE("/domains/:domain", handler.SetupDomainDelete(factory))
e.POST("/domains/:domain/signin", handler.SetupDomainSigninPost(factory))
e.GET("/domains/:domain/users", handler.SetupDomainUsersGet(factory, setupTemplates))
e.POST("/domains/:domain/users", handler.SetupDomainUserPost(factory, setupTemplates))
e.POST("/domains/:domain/users/:user/invite", handler.SetupDomainUserInvite(factory, setupTemplates))
e.DELETE("/domains/:domain/users/:user", handler.SetupDomainUserDelete(factory, setupTemplates))
e.GET("/oauth", handler.SetupOAuthList(factory, setupTemplates))
e.GET("/oauth/:provider", handler.SetupOAuthGet(factory, setupTemplates))
e.POST("/oauth/:provider", handler.SetupOAuthPost(factory, setupTemplates))
e.GET("/.themes/:themeId/:bundleId", handler.GetThemeBundle(factory))
e.GET("/.themes/:themeId/resources/:filename", handler.GetThemeResource(factory))
}
// makeStandardRoutes generates a new Echo instance the primary server behavior
func makeStandardRoutes(factory *server.Factory, e *echo.Echo) {
log.Info().Msg("Starting Emissary Server.")
e.Pre(mw.HttpsRedirect)
e.Pre(middleware.RemoveTrailingSlash())
// Middleware for standard pages
e.Use(mw.Domain(factory))
e.Use(steranko.Middleware(factory))
e.Use(middleware.CORS())
// TODO: MEDIUM: Add other Well-Known API calls?
// https://en.wikipedia.org/wiki/List_of_/.well-known/_services_offered_by_webservers
e.GET("/favicon.ico", handler.GetFavicon(factory))
e.GET("/.well-known/change-password", handler.GetChangePassword(factory))
e.GET("/.well-known/host-meta", handler.GetHostMeta(factory))
e.GET("/.well-known/host-meta.json", handler.GetHostMetaJSON(factory))
e.GET("/.well-known/nodeinfo", handler.GetNodeInfo(factory))
e.GET("/nodeinfo/2.0", handler.GetNodeInfo20(factory))
e.GET("/nodeinfo/2.1", handler.GetNodeInfo21(factory))
e.GET("/.well-known/oembed", handler.GetOEmbed(factory))
e.GET("/.well-known/webfinger", handler.GetWebfinger(factory))
// Built-In Service Routes
e.GET("/.themes/:themeId/:bundleId", handler.GetThemeBundle(factory))
e.GET("/.themes/:themeId/resources/:filename", handler.GetThemeResource(factory))
e.GET("/.templates/:templateId/:bundleId", handler.GetTemplateBundle(factory))
e.GET("/.templates/:templateId/resources/:filename", handler.GetTemplateResource(factory))
e.GET("/.widgets/:widgetId/:bundleId", handler.GetWidgetBundle(factory))
e.GET("/.widgets/:widgetId//resources/:filename", handler.GetWidgetResource(factory))
e.GET("/.giphy", handler.GetGiphyWidget(factory))
e.POST("/.ostatus/discover", handler.PostOStatusDiscover(factory))
e.GET("/.ostatus/tunnel", handler.GetFollowingTunnel)
e.POST("/.webmention", handler.PostWebMention(factory))
e.GET("/.websub/:userId/:followingId", handler.GetWebSubClient(factory))
e.POST("/.websub/:userId/:followingId", handler.PostWebSubClient(factory))
// Authentication Pages
e.GET("/signin", handler.GetSignIn(factory))
e.POST("/signin", handler.PostSignIn(factory))
e.POST("/signout", handler.PostSignOut(factory))
e.GET("/register", handler.GetRegister(factory))
e.POST("/register", handler.PostRegister(factory))
e.GET("/signin/reset", handler.GetResetPassword(factory))
e.POST("/signin/reset", handler.PostResetPassword(factory))
e.GET("/signin/reset-code", handler.GetResetCode(factory))
e.POST("/signin/reset-code", handler.PostResetCode(factory))
// STREAM PAGES
e.GET("/", handler.GetStream(factory))
e.GET("/:stream", handler.GetStream(factory))
e.GET("/:stream/:action", handler.GetStreamWithAction(factory))
e.POST("/:stream/:action", handler.PostStreamWithAction(factory))
e.DELETE("/:stream", handler.PostStreamWithAction(factory))
// Hard-coded routes for additional stream services
e.GET("/:stream/attachments/:attachment", handler.GetAttachment(factory)) // TODO: LOW: Can Stream Attachments be moved into a custom build step?
e.GET("/:stream/sse", handler.ServerSentEvent(factory)) // TODO: LOW: Can SSE be moved into a custom build step?
e.GET("/:stream/qrcode", handler.GetQRCode(factory)) // TODO: LOW: Can QR Codes be moved into a custom build step?
// Profile Pages
// NOTE: these are rewritten from /@:userId by the rewrite middleware
e.GET("/@", handler.TBD)
e.GET("/@:userId", handler.GetOutbox(factory))
e.POST("/@:userId", handler.PostOutbox(factory))
e.GET("/@:userId/:action", handler.GetOutbox(factory))
e.POST("/@:userId/:action", handler.PostOutbox(factory))
e.GET("/@:userId/avatar", handler.GetProfileAvatar(factory))
// Profile Pages for "me" only routes
e.GET("/@me/inbox", handler.GetInbox(factory))
e.POST("/@me/inbox", handler.PostInbox(factory))
e.GET("/@me/inbox/:action", handler.GetInbox(factory))
e.POST("/@me/inbox/:action", handler.PostInbox(factory))
// ActivityPub Routes for Users
e.GET("/@:userId/pub", handler.GetOutbox(factory))
e.POST("/@:userId/pub/inbox", ap_user.PostInbox(factory))
e.GET("/@:userId/pub/outbox", ap_user.GetOutboxCollection(factory))
e.GET("/@:userId/pub/followers", ap_user.GetFollowersCollection(factory))
e.GET("/@:userId/pub/following", ap_user.GetFollowingCollection(factory))
e.GET("/@:userId/pub/following/:followingId", ap_user.GetFollowingRecord(factory))
e.GET("/@:userId/pub/shared", ap_user.GetResponseCollection(factory, vocab.ActivityTypeAnnounce))
e.GET("/@:userId/pub/shared/:response", ap_user.GetResponse(factory, vocab.ActivityTypeAnnounce))
e.GET("/@:userId/pub/liked", ap_user.GetResponseCollection(factory, vocab.ActivityTypeLike))
e.GET("/@:userId/pub/liked/:response", ap_user.GetResponse(factory, vocab.ActivityTypeLike))
e.GET("/@:userId/pub/disliked", ap_user.GetResponseCollection(factory, vocab.ActivityTypeDislike))
e.GET("/@:userId/pub/disliked/:response", ap_user.GetResponse(factory, vocab.ActivityTypeDislike))
e.GET("/@:userId/pub/blocked", ap_user.GetBlockedCollection(factory))
e.GET("/@:userId/pub/blocked/:ruleId", ap_user.GetBlock(factory))
// ActivityPub Routes for Streams
e.GET("/:stream/pub", ap_stream.GetJSONLD(factory))
e.POST("/:stream/pub/inbox", ap_stream.PostInbox(factory))
e.GET("/:stream/pub/outbox", ap_stream.GetOutboxCollection(factory))
e.GET("/:stream/pub/followers", ap_stream.GetFollowersCollection(factory))
// Domain Admin Pages
e.GET("/admin", handler.GetAdmin(factory), mw.Owner)
e.GET("/admin/:param1", handler.GetAdmin(factory), mw.Owner)
e.POST("/admin/:param1", handler.PostAdmin(factory), mw.Owner)
e.GET("/admin/:param1/:param2", handler.GetAdmin(factory), mw.Owner)
e.POST("/admin/:param1/:param2", handler.PostAdmin(factory), mw.Owner)
e.GET("/admin/:param1/:param2/:param3", handler.GetAdmin(factory), mw.Owner)
e.POST("/admin/:param1/:param2/:param3", handler.PostAdmin(factory), mw.Owner)
// OAuth Client Connections
e.GET("/oauth/clients/:provider", handler.GetOAuth(factory), mw.Owner)
e.GET("/oauth/clients/:provider/callback", handler.GetOAuthCallback(factory), mw.AllowCSR, mw.Owner)
e.GET("/oauth/clients/redirect", handler.OAuthRedirect(factory), mw.Owner)
// Startup Wizard
e.GET("/startup", handler.GetStartup(factory), mw.Owner)
e.GET("/startup/:action", handler.GetStartup(factory), mw.Owner)
e.POST("/startup", handler.PostStartup(factory), mw.Owner)
// OAuth Server
e.GET("/oauth/authorize", handler.GetOAuthAuthorization(factory), mw.Authenticated)
e.POST("/oauth/authorize", handler.PostOAuthAuthorization(factory), mw.Authenticated)
e.POST("/oauth/token", handler.PostOAuthToken(factory))
e.POST("/oauth/revoke", handler.PostOAuthRevoke(factory))
// Mastodon API
toot.Register(e, handler.Mastodon(factory))
}
/******************************************
* Additional Helper Functions
******************************************/
// openLocalhostBrowser opens a browser window to the localhost URL
// IF the server is configured to run on HTTP or HTTPS
func openLocalhostBrowser(factory *server.Factory, options ...config.Option) {
// Get and modify the configuration
config := factory.Config()
config.With(options...)
if portString, ok := config.HTTPPortString(); ok {
time.Sleep(500 * time.Millisecond)
if err := browser.OpenURL("http://localhost" + portString + "/"); err != nil {
derp.Report(derp.Wrap(err, "server.openLocalhostBrowser", "OS Error opening browser window"))
}
} else {
log.Error().Msg("Unable to open setup tool because no HTTP port is configured.")
os.Exit(0)
}
}
// startHTTP starts the HTTPS server using Let's Encrypt SSL certificates.
// If the configured port is not available, it will wait one second and retry until it is
func startHTTPS(factory *server.Factory, e *echo.Echo, options ...config.Option) {
// Get and modify the configuration
config := factory.Config()
config.With(options...)
// If HTTPS is configured, then try to start an HTTPS server
if portString, ok := config.HTTPSPortString(); ok {
// Find all NON-LOCAL domain names. We need AT LEAST ONE to get an SSL Certificate
domains := slice.Filter(config.DomainNames(), domain.NotLocalhost)
if len(domains) == 0 {
log.Info().Msg("Skipping HTTPS server because there are no non-local domains.")
return
}
// Initialize Let's Encrypt autocert for TLS certificates
e.AutoTLSManager = autocert.Manager{
HostPolicy: autocert.HostWhitelist(domains...),
Cache: autocert.DirCache(config.Certificates["location"]),
Prompt: autocert.AcceptTOS,
Email: config.AdminEmail,
}
log.Info().Msg("Starting HTTPS server on port " + portString + ".")
for {
if err := e.StartAutoTLS(portString); err != nil {
log.Error().Err(err).Send()
time.Sleep(1 * time.Second)
}
}
}
log.Info().Msg("NO HTTPS PORT CONFIGURED. Skipping HTTPS server.")
}
// startHTTP starts the HTTP server.
// If the configured port is not available, it will wait one second and retry until it is
func startHTTP(factory *server.Factory, e *echo.Echo, options ...config.Option) {
// Get and modify the configuration
config := factory.Config()
config.With(options...)
if portString, ok := config.HTTPPortString(); ok {
log.Info().Msg("Starting HTTP server on port " + portString + ".")
for {
if err := e.Start(portString); err != nil {
log.Error().Err(err).Send()
time.Sleep(1 * time.Second)
}
}
}
log.Info().Msg("NO HTTP PORT CONFIGURED. Skipping HTTP server")
}
func waitForSigInt() {
// Listen to the OS SIGINT channel for an interrupt signal
// Use a buffered channel to avoid missing signals as recommended for signal.Notify
// https://golang.org/pkg/os/signal/#Notify
quit := make(chan os.Signal, 1)
signal.Notify(quit, os.Interrupt)
// Wait for an interrupt signal from the OS
<-quit
// Shut down the echo server gracefully
// gracefulShutdown(e)
// Exit the program (forcefully)
os.Exit(0)
}
// gracefulShutdown listens for a SIGINT signal, then shuts down the server gracefully
func gracefulShutdown(e *echo.Echo) {
// Get a cancellation context with a 5 second timeout
// https://echo.labstack.com/docs/cookbook/graceful-shutdown
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// Try to shut down the server
if err := e.Shutdown(ctx); err != nil {
e.Logger.Fatal(err)
}
}
// errorHandler is a custom error handler that returns a JSON error message to the client
func errorHandler(err error, ctx echo.Context) {
// Special handling of permisssion errors
request := ctx.Request()
errorCode := derp.ErrorCode(err)
switch errorCode {
case http.StatusUnauthorized:
uri := request.URL
if currentPath := uri.Path; currentPath != "/signin" {
nextPage := uri.String()
_ = ctx.Redirect(http.StatusSeeOther, "/signin?next="+url.QueryEscape(nextPage))
return
}
_ = ctx.String(errorCode, derp.Message(err))
return
}
// On localhost, allow developers to see full error dump.
if domain.IsLocalhost(ctx.Request().Host) {
_ = ctx.JSONPretty(errorCode, err, " ")
derp.Report(err)
return
}
// Fall through to general error handler
_ = ctx.String(derp.ErrorCode(err), derp.Message(err))
}