diff --git a/services/auth-basic/README.md b/services/auth-basic/README.md index 5b90fdcb8..b7e9c53f4 100644 --- a/services/auth-basic/README.md +++ b/services/auth-basic/README.md @@ -1,14 +1,14 @@ # Auth-Basic -The oCIS Auth Basic service provides basic authentication for those clients who cannot handle OpenID Connect. This should only be enabled for tests and development. +The OpenCloud Auth Basic service provides basic authentication for those clients who cannot handle OpenID Connect. This should only be enabled for tests and development. -The `auth-basic` service is responsible for validating authentication of incoming requests. To do so, it will use the configured `auth manager`, see the `Auth Managers` section. Only HTTP basic auth requests to ocis will involve the `auth-basic` service. +The `auth-basic` service is responsible for validating authentication of incoming requests. To do so, it will use the configured `auth manager`, see the `Auth Managers` section. Only HTTP basic auth requests to OpenCloud will involve the `auth-basic` service. To enable `auth-basic`, you first must set `PROXY_ENABLE_BASIC_AUTH` to `true`. ## The `auth` Service Family -ocis uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: +OpenCloud uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: - `auth-app` handles authentication of external 3rd party apps - `auth-basic` handles basic authentication - `auth-bearer` handles oidc authentication @@ -21,11 +21,11 @@ Since the `auth-basic` service does not do any validation itself, it needs to be ### LDAP Auth Manager -Setting `AUTH_BASIC_AUTH_MANAGER` to `"ldap"` will configure the `auth-basic` service to use LDAP as auth manager. This is the recommended option for running in a production and testing environment. More details on how to configure LDAP with ocis can be found in the admin docs. +Setting `AUTH_BASIC_AUTH_MANAGER` to `"ldap"` will configure the `auth-basic` service to use LDAP as auth manager. This is the recommended option for running in a production and testing environment. More details on how to configure LDAP with OpenCloud can be found in the admin docs. ### Other Auth Managers -oCIS currently supports no other auth manager +OpenCloud currently supports no other auth manager ## Scalability diff --git a/services/auth-basic/pkg/command/root.go b/services/auth-basic/pkg/command/root.go index cd4835b97..466a89145 100644 --- a/services/auth-basic/pkg/command/root.go +++ b/services/auth-basic/pkg/command/root.go @@ -22,11 +22,11 @@ func GetCommands(cfg *config.Config) cli.Commands { } } -// Execute is the entry point for the ocis-auth-basic command. +// Execute is the entry point for the opencloud auth-basic command. func Execute(cfg *config.Config) error { app := clihelper.DefaultApp(&cli.App{ Name: "auth-basic", - Usage: "Provide basic authentication for oCIS", + Usage: "Provide basic authentication for OpenCloud", Commands: GetCommands(cfg), }) diff --git a/services/auth-basic/pkg/command/server.go b/services/auth-basic/pkg/command/server.go index 7e8ad9832..7ca178f3c 100644 --- a/services/auth-basic/pkg/command/server.go +++ b/services/auth-basic/pkg/command/server.go @@ -42,7 +42,7 @@ func Server(cfg *config.Config) *cli.Command { defer cancel() - // the reva runtime calls `os.Exit` in the case of a failure and there is no way for the oCIS + // the reva runtime calls `os.Exit` in the case of a failure and there is no way for the OpenCloud // runtime to catch it and restart a reva service. Therefore, we need to ensure the service has // everything it needs, before starting the service. // In this case: CA certificates diff --git a/services/auth-basic/pkg/config/config.go b/services/auth-basic/pkg/config/config.go index acdbf7422..61d7c6f5d 100644 --- a/services/auth-basic/pkg/config/config.go +++ b/services/auth-basic/pkg/config/config.go @@ -53,7 +53,7 @@ type GRPCConfig struct { type AuthProviders struct { LDAP LDAPProvider `yaml:"ldap"` OwnCloudSQL OwnCloudSQLProvider `yaml:"owncloudsql"` - JSON JSONProvider `yaml:"json,omitempty"` // not supported by the oCIS product, therefore not part of docs + JSON JSONProvider `yaml:"json,omitempty"` // not supported by the OpenCloud product, therefore not part of docs } type JSONProvider struct { diff --git a/services/auth-basic/pkg/revaconfig/config.go b/services/auth-basic/pkg/revaconfig/config.go index ec8247bca..ae99e2ea0 100644 --- a/services/auth-basic/pkg/revaconfig/config.go +++ b/services/auth-basic/pkg/revaconfig/config.go @@ -4,7 +4,7 @@ import ( "github.com/opencloud-eu/opencloud/services/auth-basic/pkg/config" ) -// AuthBasicConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service. +// AuthBasicConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service. func AuthBasicConfigFromStruct(cfg *config.Config) map[string]interface{} { rcfg := map[string]interface{}{ "shared": map[string]interface{}{ diff --git a/services/auth-bearer/README.md b/services/auth-bearer/README.md index 152359c88..0f15f7707 100644 --- a/services/auth-bearer/README.md +++ b/services/auth-bearer/README.md @@ -1,10 +1,10 @@ # Auth-Bearer -The oCIS Auth Bearer service communicates with the configured OpenID Connect identity provider to authenticate requests. OpenID Connect is the default authentication mechanism for all clients: web, desktop and mobile. Basic auth is only used for testing and has to be explicity enabled. +The OpenCloud Auth Bearer service communicates with the configured OpenID Connect identity provider to authenticate requests. OpenID Connect is the default authentication mechanism for all clients: web, desktop and mobile. Basic auth is only used for testing and has to be explicity enabled. ## The `auth` Service Family -ocis uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: +OpenCloud uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: - `auth-app` handles authentication of external 3rd party apps - `auth-basic` handles basic authentication - `auth-bearer` handles oidc authentication @@ -13,7 +13,7 @@ ocis uses serveral authentication services for different use cases. All services ## Built in OpenID Connect Identity Provider -A default oCIS deployment will start a [built in OpenID Connect identity provider](https://github.com/owncloud/ocis/tree/master/services/idp) but can be configured to use an external one as well. +A default OpenCloud deployment will start a [built in OpenID Connect identity provider](https://github.com/opencloud-eu/opencloud/tree/master/services/idp) but can be configured to use an external one as well. ## Scalability diff --git a/services/auth-bearer/pkg/command/root.go b/services/auth-bearer/pkg/command/root.go index a41c909f3..e42138dbb 100644 --- a/services/auth-bearer/pkg/command/root.go +++ b/services/auth-bearer/pkg/command/root.go @@ -25,11 +25,11 @@ func GetCommands(cfg *config.Config) cli.Commands { } } -// Execute is the entry point for the ocis-auth-bearer command. +// Execute is the entry point for the opencloud auth-bearer command. func Execute(cfg *config.Config) error { app := clihelper.DefaultApp(&cli.App{ Name: "auth-bearer", - Usage: "Provide bearer authentication for oCIS", + Usage: "Provide bearer authentication for OpenCloud", Commands: GetCommands(cfg), }) diff --git a/services/auth-bearer/pkg/revaconfig/config.go b/services/auth-bearer/pkg/revaconfig/config.go index 430ece8e5..e7b26a510 100644 --- a/services/auth-bearer/pkg/revaconfig/config.go +++ b/services/auth-bearer/pkg/revaconfig/config.go @@ -5,7 +5,7 @@ import ( "github.com/opencloud-eu/opencloud/services/auth-bearer/pkg/config" ) -// AuthBearerConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service. +// AuthBearerConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service. func AuthBearerConfigFromStruct(cfg *config.Config) map[string]interface{} { return map[string]interface{}{ "shared": map[string]interface{}{ diff --git a/services/auth-machine/README.md b/services/auth-machine/README.md index 31222489e..eb687ebbf 100644 --- a/services/auth-machine/README.md +++ b/services/auth-machine/README.md @@ -1,8 +1,8 @@ # Auth-Machine -The oCIS Auth Machine is used for interservice communication when using user impersonation. +The OpenCloud Auth Machine is used for interservice communication when using user impersonation. -ocis uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: +OpenCloud uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: - `auth-app` handles authentication of external 3rd party apps - `auth-basic` handles basic authentication - `auth-bearer` handles oidc authentication @@ -11,7 +11,7 @@ ocis uses serveral authentication services for different use cases. All services ## User Impersonation -When one ocis service is trying to talk to other ocis services, it needs to authenticate itself. To do so, it will impersonate a user using the `auth-machine` service. It will then act on behalf of this user. Any action will show up as action of this specific user, which gets visible when e.g. logged in the audit log. +When one OpenCloud service is trying to talk to other OpenCloud services, it needs to authenticate itself. To do so, it will impersonate a user using the `auth-machine` service. It will then act on behalf of this user. Any action will show up as action of this specific user, which gets visible when e.g. logged in the audit log. ## Deprecation diff --git a/services/auth-machine/pkg/command/root.go b/services/auth-machine/pkg/command/root.go index e2c5c0b74..1015c6d0c 100644 --- a/services/auth-machine/pkg/command/root.go +++ b/services/auth-machine/pkg/command/root.go @@ -22,11 +22,11 @@ func GetCommands(cfg *config.Config) cli.Commands { } } -// Execute is the entry point for the ocis-auth-machine command. +// Execute is the entry point for the opencloud auth-machine command. func Execute(cfg *config.Config) error { app := clihelper.DefaultApp(&cli.App{ Name: "auth-machine", - Usage: "Provide machine authentication for oCIS", + Usage: "Provide machine authentication for OpenCloud", Commands: GetCommands(cfg), }) diff --git a/services/auth-machine/pkg/revaconfig/config.go b/services/auth-machine/pkg/revaconfig/config.go index e26e0bb1d..df4d42c8c 100644 --- a/services/auth-machine/pkg/revaconfig/config.go +++ b/services/auth-machine/pkg/revaconfig/config.go @@ -4,7 +4,7 @@ import ( "github.com/opencloud-eu/opencloud/services/auth-machine/pkg/config" ) -// AuthMachineConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service. +// AuthMachineConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service. func AuthMachineConfigFromStruct(cfg *config.Config) map[string]interface{} { return map[string]interface{}{ "shared": map[string]interface{}{ diff --git a/services/auth-service/README.md b/services/auth-service/README.md index 2a9ac8f30..38582621e 100644 --- a/services/auth-service/README.md +++ b/services/auth-service/README.md @@ -1,10 +1,10 @@ # Auth-Service -The ocis Auth Service is used to authenticate service accounts. Compared to normal accounts, service accounts are ocis internal only and not available as ordinary users like via LDAP. +The OpenCloud Auth Service is used to authenticate service accounts. Compared to normal accounts, service accounts are OpenCloud internal only and not available as ordinary users like via LDAP. ## The `auth` Service Family -ocis uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: +OpenCloud uses serveral authentication services for different use cases. All services that start with `auth-` are part of the authentication service family. Each member authenticates requests with different scopes. As of now, these services exist: - `auth-app` handles authentication of external 3rd party apps - `auth-basic` handles basic authentication - `auth-bearer` handles oidc authentication diff --git a/services/auth-service/pkg/command/root.go b/services/auth-service/pkg/command/root.go index 4e2d35626..fe7f98ae3 100644 --- a/services/auth-service/pkg/command/root.go +++ b/services/auth-service/pkg/command/root.go @@ -22,11 +22,11 @@ func GetCommands(cfg *config.Config) cli.Commands { } } -// Execute is the entry point for the ocis-auth-service command. +// Execute is the entry point for the opencloud auth-service command. func Execute(cfg *config.Config) error { app := clihelper.DefaultApp(&cli.App{ Name: "auth-service", - Usage: "Provide service authentication for oCIS", + Usage: "Provide service authentication for OpenCloud", Commands: GetCommands(cfg), }) diff --git a/services/auth-service/pkg/revaconfig/config.go b/services/auth-service/pkg/revaconfig/config.go index 6f97eb7c8..47b52a893 100644 --- a/services/auth-service/pkg/revaconfig/config.go +++ b/services/auth-service/pkg/revaconfig/config.go @@ -4,7 +4,7 @@ import ( "github.com/opencloud-eu/opencloud/services/auth-service/pkg/config" ) -// AuthMachineConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service. +// AuthMachineConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service. func AuthMachineConfigFromStruct(cfg *config.Config) map[string]interface{} { return map[string]interface{}{ "core": map[string]interface{}{