server

func WithAdditionalCORSExposedHeaders ¶ added in v0.12.0

func WithAdditionalCORSExposedHeaders(headers ...string) StartOptions

WithAdditionalCORSExposedHeaders appends additional response headers to expose via CORS. These are merged with headers from YAML config (server.cors.exposedheaders and server.cors.additionalexposedheaders). Deduplication is handled automatically with case-insensitive comparison per RFC 7230.

Example:

server.Start(
    server.WithAdditionalCORSExposedHeaders("X-Request-Id", "X-Trace-Id"),
)

func WithAdditionalCORSHeaders ¶ added in v0.12.0

func WithAdditionalCORSHeaders(headers ...string) StartOptions

WithAdditionalCORSHeaders appends additional request headers to allow via CORS. These are merged with headers from YAML config (server.cors.allowedheaders and server.cors.additionalheaders). Deduplication is handled automatically with case-insensitive comparison per RFC 7230.

Example:

server.Start(
    server.WithAdditionalCORSHeaders("X-Custom-Header", "X-Another-Header"),
)

func WithAdditionalCORSMethods ¶ added in v0.12.0

func WithAdditionalCORSMethods(methods ...string) StartOptions

WithAdditionalCORSMethods appends additional HTTP methods to allow via CORS. These are merged with methods from YAML config (server.cors.allowedmethods and server.cors.additionalmethods). Deduplication is handled automatically.

Example:

server.Start(
    server.WithAdditionalCORSMethods("CUSTOM", "SPECIAL"),
)

func WithAdditionalConfigLoader ¶ added in v0.5.3

func WithAdditionalConfigLoader(loader config.Loader) StartOptions

WithAdditionalConfigLoader option adds an additional configuration loader to the server.

func WithAuthZRoleProvider ¶ added in v0.13.0

func WithAuthZRoleProvider(provider authz.RoleProvider) StartOptions

WithAuthZRoleProvider option sets a role provider directly.

func WithAuthZRoleProviderFactory ¶ added in v0.13.0

func WithAuthZRoleProviderFactory(name string, factory authz.RoleProviderFactory) StartOptions

WithAuthZRoleProviderFactory option registers a named role provider factory.

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 WithConfigLoaderOrder ¶ added in v0.10.0

func WithConfigLoaderOrder(loaderOrder []string) StartOptions

WithConfigLoaderOrder option is a slice of config.Loader names and is used as the priority of the loaders.

func WithConnectInterceptors ¶ added in v0.13.0

func WithConnectInterceptors(interceptors ...connect.Interceptor) StartOptions

WithConnectInterceptors appends additional Connect interceptors (server-side) applied to all RPCs.

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 WithIPCInterceptors ¶ added in v0.13.0

func WithIPCInterceptors(interceptors ...connect.Interceptor) StartOptions

WithIPCInterceptors appends additional Connect interceptors for in-process IPC server.

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 WithTrustKeyManagerCtxFactories ¶ added in v0.10.0

func WithTrustKeyManagerCtxFactories(factories ...trust.NamedKeyManagerCtxFactory) StartOptions

WithTrustKeyManagerCtxFactories option provides factories for creating trust key managers.

func WithTrustKeyManagerFactories ¶ added in v0.7.0

func WithTrustKeyManagerFactories(factories ...trust.NamedKeyManagerFactory) StartOptions

WithTrustKeyManagerFactories option provides factories for creating trust key managers. Use WithTrustKeyManagerCtxFactories instead. EXPERIMENTAL

func WithWaitForShutdownSignal ¶

func WithWaitForShutdownSignal() StartOptions

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