2022-02-09 15:01:19 +01:00
|
|
|
package start
|
|
|
|
|
|
|
|
import (
|
2022-02-14 17:22:30 +01:00
|
|
|
"context"
|
2022-06-24 14:38:22 +02:00
|
|
|
"crypto/tls"
|
2022-02-14 17:22:30 +01:00
|
|
|
"database/sql"
|
2022-02-09 15:01:19 +01:00
|
|
|
_ "embed"
|
2022-02-14 17:22:30 +01:00
|
|
|
"fmt"
|
|
|
|
"net"
|
|
|
|
"net/http"
|
|
|
|
"os"
|
|
|
|
"os/signal"
|
|
|
|
"syscall"
|
|
|
|
"time"
|
2022-02-09 15:01:19 +01:00
|
|
|
|
2022-09-12 17:18:08 +01:00
|
|
|
"github.com/zitadel/saml/pkg/provider"
|
|
|
|
|
|
|
|
"github.com/zitadel/zitadel/internal/api/saml"
|
|
|
|
|
2022-02-14 17:22:30 +01:00
|
|
|
"github.com/gorilla/mux"
|
2022-02-09 15:01:19 +01:00
|
|
|
"github.com/spf13/cobra"
|
2022-02-14 17:22:30 +01:00
|
|
|
"github.com/spf13/viper"
|
2022-04-27 01:01:45 +02:00
|
|
|
"github.com/zitadel/logging"
|
|
|
|
"github.com/zitadel/oidc/v2/pkg/op"
|
2022-02-14 17:22:30 +01:00
|
|
|
"golang.org/x/net/http2"
|
|
|
|
"golang.org/x/net/http2/h2c"
|
|
|
|
|
2022-06-27 12:32:34 +02:00
|
|
|
"github.com/zitadel/zitadel/cmd/key"
|
|
|
|
cmd_tls "github.com/zitadel/zitadel/cmd/tls"
|
2022-04-27 01:01:45 +02:00
|
|
|
admin_es "github.com/zitadel/zitadel/internal/admin/repository/eventsourcing"
|
|
|
|
"github.com/zitadel/zitadel/internal/api"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/assets"
|
|
|
|
internal_authz "github.com/zitadel/zitadel/internal/api/authz"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/grpc/admin"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/grpc/auth"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/grpc/management"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/grpc/system"
|
2022-05-31 13:11:49 +02:00
|
|
|
http_util "github.com/zitadel/zitadel/internal/api/http"
|
2022-04-27 01:01:45 +02:00
|
|
|
"github.com/zitadel/zitadel/internal/api/http/middleware"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/oidc"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/ui/console"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/ui/login"
|
|
|
|
auth_es "github.com/zitadel/zitadel/internal/auth/repository/eventsourcing"
|
|
|
|
"github.com/zitadel/zitadel/internal/authz"
|
|
|
|
authz_repo "github.com/zitadel/zitadel/internal/authz/repository"
|
|
|
|
"github.com/zitadel/zitadel/internal/command"
|
|
|
|
cryptoDB "github.com/zitadel/zitadel/internal/crypto/database"
|
|
|
|
"github.com/zitadel/zitadel/internal/database"
|
|
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
|
|
"github.com/zitadel/zitadel/internal/id"
|
|
|
|
"github.com/zitadel/zitadel/internal/notification"
|
|
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
|
|
"github.com/zitadel/zitadel/internal/static"
|
|
|
|
"github.com/zitadel/zitadel/internal/webauthn"
|
|
|
|
"github.com/zitadel/zitadel/openapi"
|
2022-02-09 15:01:19 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
func New() *cobra.Command {
|
2022-02-14 17:22:30 +01:00
|
|
|
start := &cobra.Command{
|
2022-02-09 15:01:19 +01:00
|
|
|
Use: "start",
|
|
|
|
Short: "starts ZITADEL instance",
|
|
|
|
Long: `starts ZITADEL.
|
|
|
|
Requirements:
|
|
|
|
- cockroachdb`,
|
|
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
2022-06-24 14:38:22 +02:00
|
|
|
err := cmd_tls.ModeFromFlag(cmd)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2022-03-28 10:05:09 +02:00
|
|
|
config := MustNewConfig(viper.GetViper())
|
2022-04-04 10:10:57 +02:00
|
|
|
masterKey, err := key.MasterKey(cmd)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2022-03-28 10:05:09 +02:00
|
|
|
|
2022-03-14 07:55:09 +01:00
|
|
|
return startZitadel(config, masterKey)
|
2022-02-09 15:01:19 +01:00
|
|
|
},
|
|
|
|
}
|
2022-02-14 17:22:30 +01:00
|
|
|
|
2022-03-28 10:05:09 +02:00
|
|
|
startFlags(start)
|
2022-03-14 07:55:09 +01:00
|
|
|
|
2022-02-14 17:22:30 +01:00
|
|
|
return start
|
|
|
|
}
|
|
|
|
|
2022-03-28 10:05:09 +02:00
|
|
|
func startZitadel(config *Config, masterKey string) error {
|
2022-02-14 17:22:30 +01:00
|
|
|
ctx := context.Background()
|
|
|
|
|
2022-07-28 16:25:42 +02:00
|
|
|
dbClient, err := database.Connect(config.Database, false)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start client for projection: %w", err)
|
|
|
|
}
|
2022-03-14 07:55:09 +01:00
|
|
|
|
|
|
|
keyStorage, err := cryptoDB.NewKeyStorage(dbClient, masterKey)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start key storage: %w", err)
|
|
|
|
}
|
|
|
|
keys, err := ensureEncryptionKeys(config.EncryptionKeys, keyStorage)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2022-02-14 17:22:30 +01:00
|
|
|
eventstoreClient, err := eventstore.Start(dbClient)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start eventstore for queries: %w", err)
|
|
|
|
}
|
2022-02-16 16:49:17 +01:00
|
|
|
|
2022-09-12 17:18:08 +01:00
|
|
|
queries, err := query.StartQueries(ctx, eventstoreClient, dbClient, config.Projections, config.SystemDefaults, keys.IDPConfig, keys.OTP, keys.OIDC, keys.SAML, config.InternalAuthZ.RolePermissionMappings)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start queries: %w", err)
|
|
|
|
}
|
|
|
|
|
2022-08-23 08:02:36 +02:00
|
|
|
authZRepo, err := authz.Start(queries, dbClient, keys.OIDC, config.ExternalSecure)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("error starting authz repo: %w", err)
|
|
|
|
}
|
2022-04-06 08:13:40 +02:00
|
|
|
|
|
|
|
storage, err := config.AssetStorage.NewStorage(dbClient)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start asset storage client: %w", err)
|
|
|
|
}
|
2022-04-25 10:01:17 +02:00
|
|
|
webAuthNConfig := &webauthn.Config{
|
|
|
|
DisplayName: config.WebAuthNName,
|
|
|
|
ExternalSecure: config.ExternalSecure,
|
2022-02-14 17:22:30 +01:00
|
|
|
}
|
2022-04-25 11:16:36 +02:00
|
|
|
commands, err := command.StartCommands(
|
|
|
|
eventstoreClient,
|
|
|
|
config.SystemDefaults,
|
|
|
|
config.InternalAuthZ.RolePermissionMappings,
|
|
|
|
storage,
|
|
|
|
webAuthNConfig,
|
2022-04-28 10:30:41 +02:00
|
|
|
config.ExternalDomain,
|
2022-04-25 11:16:36 +02:00
|
|
|
config.ExternalSecure,
|
|
|
|
config.ExternalPort,
|
|
|
|
keys.IDPConfig,
|
|
|
|
keys.OTP,
|
|
|
|
keys.SMTP,
|
|
|
|
keys.SMS,
|
|
|
|
keys.User,
|
|
|
|
keys.DomainVerification,
|
|
|
|
keys.OIDC,
|
2022-09-12 17:18:08 +01:00
|
|
|
keys.SAML,
|
|
|
|
&http.Client{},
|
2022-04-25 11:16:36 +02:00
|
|
|
)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("cannot start commands: %w", err)
|
|
|
|
}
|
|
|
|
|
2022-09-21 16:18:55 +02:00
|
|
|
notification.Start(ctx, config.Projections.Customizations["notifications"], config.ExternalPort, config.ExternalSecure, commands, queries, eventstoreClient, assets.AssetAPIFromDomain(config.ExternalSecure, config.ExternalPort), config.SystemDefaults.Notifications.FileSystemPath, keys.User, keys.SMTP, keys.SMS)
|
2022-02-14 17:22:30 +01:00
|
|
|
|
|
|
|
router := mux.NewRouter()
|
2022-06-24 14:38:22 +02:00
|
|
|
tlsConfig, err := config.TLS.Config()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
err = startAPIs(ctx, router, commands, queries, eventstoreClient, dbClient, config, storage, authZRepo, keys)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2022-06-24 14:38:22 +02:00
|
|
|
return listen(ctx, router, config.Port, tlsConfig)
|
2022-02-14 17:22:30 +01:00
|
|
|
}
|
|
|
|
|
2022-06-24 14:38:22 +02:00
|
|
|
func startAPIs(ctx context.Context, router *mux.Router, commands *command.Commands, queries *query.Queries, eventstore *eventstore.Eventstore, dbClient *sql.DB, config *Config, store static.Storage, authZRepo authz_repo.Repository, keys *encryptionKeys) error {
|
2022-02-14 17:22:30 +01:00
|
|
|
repo := struct {
|
|
|
|
authz_repo.Repository
|
|
|
|
*query.Queries
|
|
|
|
}{
|
|
|
|
authZRepo,
|
|
|
|
queries,
|
|
|
|
}
|
2022-06-24 14:38:22 +02:00
|
|
|
verifier := internal_authz.Start(repo, http_util.BuildHTTP(config.ExternalDomain, config.ExternalPort, config.ExternalSecure), config.SystemAPIUsers)
|
|
|
|
tlsConfig, err := config.TLS.Config()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
apis := api.New(config.Port, router, queries, verifier, config.InternalAuthZ, config.ExternalSecure, tlsConfig, config.HTTP2HostHeader, config.HTTP1HostHeader)
|
2022-05-30 13:27:52 +02:00
|
|
|
authRepo, err := auth_es.Start(config.Auth, config.SystemDefaults, commands, queries, dbClient, keys.OIDC, keys.User)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("error starting auth repo: %w", err)
|
|
|
|
}
|
2022-05-16 16:35:49 +02:00
|
|
|
adminRepo, err := admin_es.Start(config.Admin, store, dbClient)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("error starting admin repo: %w", err)
|
|
|
|
}
|
2022-09-23 14:08:10 +02:00
|
|
|
if err := apis.RegisterServer(ctx, system.CreateServer(commands, queries, adminRepo, config.Database.Database(), config.DefaultInstance, config.ExternalDomain)); err != nil {
|
2022-02-14 17:22:30 +01:00
|
|
|
return err
|
|
|
|
}
|
2022-07-28 16:25:42 +02:00
|
|
|
if err := apis.RegisterServer(ctx, admin.CreateServer(config.Database.Database(), commands, queries, config.SystemDefaults, adminRepo, config.ExternalSecure, keys.User)); err != nil {
|
2022-02-14 17:22:30 +01:00
|
|
|
return err
|
|
|
|
}
|
2022-06-07 10:04:51 +02:00
|
|
|
if err := apis.RegisterServer(ctx, management.CreateServer(commands, queries, config.SystemDefaults, keys.User, config.ExternalSecure, config.AuditLogRetention)); err != nil {
|
2022-04-21 12:37:39 +02:00
|
|
|
return err
|
|
|
|
}
|
2022-05-30 13:38:30 +02:00
|
|
|
if err := apis.RegisterServer(ctx, auth.CreateServer(commands, queries, authRepo, config.SystemDefaults, keys.User, config.ExternalSecure, config.AuditLogRetention)); err != nil {
|
2022-02-14 17:22:30 +01:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2022-05-02 17:26:54 +02:00
|
|
|
instanceInterceptor := middleware.InstanceInterceptor(queries, config.HTTP1HostHeader, login.IgnoreInstanceEndpoints...)
|
2022-08-16 07:04:36 +02:00
|
|
|
assetsCache := middleware.AssetsCacheInterceptor(config.AssetStorage.Cache.MaxAge, config.AssetStorage.Cache.SharedMaxAge)
|
|
|
|
apis.RegisterHandler(assets.HandlerPrefix, assets.NewHandler(commands, verifier, config.InternalAuthZ, id.SonyFlakeGenerator(), store, queries, instanceInterceptor.Handler, assetsCache.Handler))
|
2022-02-14 17:22:30 +01:00
|
|
|
|
feat: Configurable Unique Machine Identification (#3626)
* feat: Configurable Unique Machine Identification
This change fixes Segfault on AWS App Runner with v2 #3625
The change introduces two new dependencies:
* github.com/drone/envsubst for supporting AWS ECS, which has its metadata endpoint described by an environment variable
* github.com/jarcoal/jpath so that only relevant data from a metadata response is used to identify the machine.
The change ads new configuration (see `defaults.yaml`):
* `Machine.Identification` enables configuration of how machines are uniquely identified - I'm not sure about the top level category `Machine`, as I don't have anything else to add to it. Happy to hear suggestions for better naming or structure here.
* `Machine.Identifiation.PrivateId` turns on or off the existing private IP based identification. Default is on.
* `Machine.Identification.Hostname` turns on or off using the OS hostname to identify the machine. Great for most cloud environments, where this tends to be set to something that identifies the machine uniquely. Enabled by default.
* `Machine.Identification.Webhook` configures identification based on the response to an HTTP GET request. Request headers can be configured, a JSONPath can be set for processing the response (no JSON parsing is done if this is not set), and the URL is allowed to contain environment variables in the format `"${var}"`.
The new flow for getting a unique machine id is:
1. PrivateIP (if enabled)
2. Hostname (if enabled)
3. Webhook (if enabled, to configured URL)
4. Give up and error out.
It's important that init configures machine identity first. Otherwise we could try to get an ID before configuring it. To prevent this from causing difficult to debug issues, where for example the default configuration was used, I've ensured that
the application will generate an error if the module hasn't been configured and you try to get an ID.
Misc changes:
* Spelling and gramatical corrections to `init.go::New()` long description.
* Spelling corrections to `verify_zitadel.go::newZitadel()`.
* Updated `production.md` and `development.md` based on the new build process. I think the run instructions are also out of date, but I'll leave that for someone else.
* `id.SonyFlakeGenerator` is now a function, which sets `id.sonyFlakeGenerator`, this allows us to defer initialization until configuration has been read.
* Update internal/id/config.go
Co-authored-by: Alexei-Barnes <82444470+Alexei-Barnes@users.noreply.github.com>
* Fix authored by @livio-a for tests
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-05-24 15:57:57 +01:00
|
|
|
userAgentInterceptor, err := middleware.NewUserAgentHandler(config.UserAgentCookie, keys.UserAgentCookieKey, id.SonyFlakeGenerator(), config.ExternalSecure, login.EndpointResources)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
openAPIHandler, err := openapi.Start()
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to start openapi handler: %w", err)
|
|
|
|
}
|
2022-05-30 13:38:30 +02:00
|
|
|
apis.RegisterHandler(openapi.HandlerPrefix, openAPIHandler)
|
2022-02-14 17:22:30 +01:00
|
|
|
|
2022-06-07 10:04:51 +02:00
|
|
|
oidcProvider, err := oidc.NewProvider(ctx, config.OIDC, login.DefaultLoggedOutPath, config.ExternalSecure, commands, queries, authRepo, keys.OIDC, keys.OIDCKey, eventstore, dbClient, userAgentInterceptor, instanceInterceptor.Handler)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to start oidc provider: %w", err)
|
|
|
|
}
|
|
|
|
|
2022-09-12 17:18:08 +01:00
|
|
|
samlProvider, err := saml.NewProvider(ctx, config.SAML, config.ExternalSecure, commands, queries, authRepo, keys.OIDC, keys.SAML, eventstore, dbClient, instanceInterceptor.Handler, userAgentInterceptor)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to start saml provider: %w", err)
|
|
|
|
}
|
|
|
|
apis.RegisterHandler(saml.HandlerPrefix, samlProvider.HttpHandler())
|
|
|
|
|
2022-06-24 13:18:54 +02:00
|
|
|
c, err := console.Start(config.Console, config.ExternalSecure, oidcProvider.IssuerFromRequest, instanceInterceptor.Handler, config.CustomerPortal)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to start console: %w", err)
|
|
|
|
}
|
2022-05-30 13:38:30 +02:00
|
|
|
apis.RegisterHandler(console.HandlerPrefix, c)
|
2022-02-14 17:22:30 +01:00
|
|
|
|
2022-09-12 17:18:08 +01:00
|
|
|
l, err := login.CreateLogin(config.Login, commands, queries, authRepo, store, console.HandlerPrefix+"/", op.AuthCallbackURL(oidcProvider), provider.AuthCallbackURL(samlProvider), config.ExternalSecure, userAgentInterceptor, op.NewIssuerInterceptor(oidcProvider.IssuerFromRequest).Handler, provider.NewIssuerInterceptor(samlProvider.IssuerFromRequest).Handler, instanceInterceptor.Handler, assetsCache.Handler, keys.User, keys.IDPConfig, keys.CSRFCookieKey)
|
2022-02-14 17:22:30 +01:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("unable to start login: %w", err)
|
|
|
|
}
|
2022-05-30 13:38:30 +02:00
|
|
|
apis.RegisterHandler(login.HandlerPrefix, l.Handler())
|
2022-02-14 17:22:30 +01:00
|
|
|
|
2022-06-07 10:04:51 +02:00
|
|
|
//handle oidc at last, to be able to handle the root
|
|
|
|
//we might want to change that in the future
|
|
|
|
//esp. if we want to have multiple well-known endpoints
|
|
|
|
//it might make sense to handle the discovery endpoint and oauth and oidc prefixes individually
|
|
|
|
//but this will require a change in the oidc lib
|
|
|
|
apis.RegisterHandler("", oidcProvider.HttpHandler())
|
2022-02-14 17:22:30 +01:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2022-06-24 14:38:22 +02:00
|
|
|
func listen(ctx context.Context, router *mux.Router, port uint16, tlsConfig *tls.Config) error {
|
2022-02-14 17:22:30 +01:00
|
|
|
http2Server := &http2.Server{}
|
2022-06-24 14:38:22 +02:00
|
|
|
http1Server := &http.Server{Handler: h2c.NewHandler(router, http2Server), TLSConfig: tlsConfig}
|
2022-02-14 17:22:30 +01:00
|
|
|
lis, err := net.Listen("tcp", fmt.Sprintf(":%d", port))
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("tcp listener on %d failed: %w", port, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
errCh := make(chan error)
|
|
|
|
|
|
|
|
go func() {
|
|
|
|
logging.Infof("server is listening on %s", lis.Addr().String())
|
2022-06-24 14:38:22 +02:00
|
|
|
if tlsConfig != nil {
|
|
|
|
//we don't need to pass the files here, because we already initialized the TLS config on the server
|
|
|
|
errCh <- http1Server.ServeTLS(lis, "", "")
|
|
|
|
} else {
|
|
|
|
errCh <- http1Server.Serve(lis)
|
|
|
|
}
|
2022-02-14 17:22:30 +01:00
|
|
|
}()
|
|
|
|
|
|
|
|
shutdown := make(chan os.Signal, 1)
|
|
|
|
signal.Notify(shutdown, os.Interrupt, syscall.SIGTERM)
|
|
|
|
|
|
|
|
select {
|
|
|
|
case err := <-errCh:
|
|
|
|
return fmt.Errorf("error starting server: %w", err)
|
|
|
|
case <-shutdown:
|
|
|
|
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
|
|
|
|
defer cancel()
|
|
|
|
return shutdownServer(ctx, http1Server)
|
|
|
|
case <-ctx.Done():
|
|
|
|
return shutdownServer(ctx, http1Server)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func shutdownServer(ctx context.Context, server *http.Server) error {
|
|
|
|
err := server.Shutdown(ctx)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("could not shutdown gracefully: %w", err)
|
|
|
|
}
|
|
|
|
logging.New().Info("server shutdown gracefully")
|
|
|
|
return nil
|
|
|
|
}
|