Rebrand auth-{basic,bearer,machine,service}

This commit is contained in:
André Duffeck
2025-01-16 13:56:16 +01:00
parent 31965a8f9d
commit c982a81135
14 changed files with 27 additions and 27 deletions

View File

@@ -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

View File

@@ -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),
})

View File

@@ -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

View File

@@ -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 {

View File

@@ -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{}{