server

func WithAdditionalConfigLoader ¶ added in v0.5.3

func WithAdditionalConfigLoader(loader config.Loader) StartOptions

WithAdditionalConfigLoader option adds an additional configuration loader to the server.

func WithBuiltinAuthZPolicy ¶ added in v0.4.30

func WithBuiltinAuthZPolicy(policy string) StartOptions

WithAuthZPolicy option sets the default casbin policy to be used. Example:

  opentdf.WithAuthZPolicy(strings.Join([]string{
	   "p, role:admin, pep*, *, allow",
	   "p, role:standard, pep*, read, allow",
	 }, "\n")),

func WithCasbinAdapter ¶ added in v0.4.30

func WithCasbinAdapter(adapter persist.Adapter) StartOptions

WithCasbinAdapter option sets the casbin adapter to be used for the casbin enforcer.

func WithConfigFile ¶

func WithConfigFile(file string) StartOptions

WithConfigFile option sets the configuration file path.

func WithConfigKey ¶

func WithConfigKey(key string) StartOptions

WithConfigKey option sets the viper configuration key(filename).

func WithCoreServices ¶ added in v0.4.18

func WithCoreServices(services ...serviceregistry.IService) StartOptions

WithCoreServices option adds additional core services to the platform It takes a variadic parameter of type serviceregistry.IService, which represents the core services to be added.

func WithIPCReauthRoutes ¶ added in v0.5.1

func WithIPCReauthRoutes(routes []string) StartOptions

WithIPCReauthRoutes option sets the IPC reauthorization routes for the server. It enables the server to reauthorize IPC routes and embed the token on the context.

func WithPublicRoutes ¶

func WithPublicRoutes(routes []string) StartOptions

WithPublicRoutes option sets the public routes for the server. It allows bypassing the authorization middleware for the specified routes. *** This should be used with caution as it can expose sensitive data. ***

func WithServices ¶ added in v0.4.18

func WithServices(services ...serviceregistry.IService) StartOptions

WithServices option adds additional services to the platform. It takes a variadic parameter of type serviceregistry.IService, which represents the services to be added.

This will set the mode for these services to the Namespace name. To understand the registration of these services more fully, including the service "mode", follow the usage of the extraServices field in StartConfig.

func WithTrustKeyIndex ¶ added in v0.5.3

func WithTrustKeyIndex(index trust.KeyIndex) StartOptions

WithTrustKeyIndex option sets the trust index to be used for the server.

func WithTrustKeyManager ¶ added in v0.5.3

func WithTrustKeyManager(manager trust.KeyManager) StartOptions

WithTrustKeyManager option sets the trust key manager to be used for the server.

func WithTrustKeyService ¶ added in v0.5.3

func WithTrustKeyService(index trust.KeyIndex, manager trust.KeyManager) StartOptions

WithTrustKeyService option sets both the index and manager for the trust key service.

func WithWaitForShutdownSignal ¶

func WithWaitForShutdownSignal() StartOptions

WithWaitForShutdownSignal option allows the server to wait for a shutdown signal before exiting.