From ea331941c7e4a8d2809af80b50d15b2060871a53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Duffeck?= Date: Thu, 16 Jan 2025 13:04:36 +0100 Subject: [PATCH] Rebrand auth-app --- services/auth-app/README.md | 8 ++++---- services/auth-app/pkg/command/root.go | 4 ++-- services/auth-app/pkg/revaconfig/config.go | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/services/auth-app/README.md b/services/auth-app/README.md index bdc23a89d..304473dcf 100644 --- a/services/auth-app/README.md +++ b/services/auth-app/README.md @@ -4,7 +4,7 @@ The auth-app service provides authentication for 3rd party apps. ## 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 @@ -28,16 +28,16 @@ App Tokens are used to authenticate 3rd party access via https like when using c Replace the `user-name` with an existing user. For the `token-expiration`, you can use any time abbreviation from the following list: `h, m, s`. Examples: `72h` or `1h` or `1m` or `1s.` Default is `72h`. ```bash -ocis auth-app create --user-name={user-name} --expiration={token-expiration} +opencloud auth-app create --user-name={user-name} --expiration={token-expiration} ``` -Once generated, these tokens can be used to authenticate requests to ocis. They are passed as part of the request as `Basic Auth` header. +Once generated, these tokens can be used to authenticate requests to OpenCloud. They are passed as part of the request as `Basic Auth` header. ### Via API The `auth-app` service provides an API to create (POST), list (GET) and delete (DELETE) tokens at the `/auth-app/tokens` endpoint. -When using curl for the respective command, you need to authenticate with a header. To do so, get from the browsers developer console the currently active bearer token. Consider that this token has a short lifetime. In any example, replace `` with the URL:port of your Infinite Scale instance, and `{token}` `{value}` accordingly. Note that the active bearer token authenticates the user the token was issued for. +When using curl for the respective command, you need to authenticate with a header. To do so, get from the browsers developer console the currently active bearer token. Consider that this token has a short lifetime. In any example, replace `` with the URL:port of your OpenCloud instance, and `{token}` `{value}` accordingly. Note that the active bearer token authenticates the user the token was issued for. * **Create a token**\ The POST request requires: diff --git a/services/auth-app/pkg/command/root.go b/services/auth-app/pkg/command/root.go index 88f56b731..3371c99df 100644 --- a/services/auth-app/pkg/command/root.go +++ b/services/auth-app/pkg/command/root.go @@ -23,11 +23,11 @@ func GetCommands(cfg *config.Config) cli.Commands { } } -// Execute is the entry point for the ocis-auth-app command. +// Execute is the entry point for the opencloud auth-app command. func Execute(cfg *config.Config) error { app := clihelper.DefaultApp(&cli.App{ Name: "auth-app", - Usage: "Provide app authentication for oCIS", + Usage: "Provide app authentication for OpenCloud", Commands: GetCommands(cfg), }) diff --git a/services/auth-app/pkg/revaconfig/config.go b/services/auth-app/pkg/revaconfig/config.go index a82faee9c..325e222b8 100644 --- a/services/auth-app/pkg/revaconfig/config.go +++ b/services/auth-app/pkg/revaconfig/config.go @@ -7,7 +7,7 @@ import ( "github.com/opencloud-eu/opencloud/services/auth-app/pkg/config" ) -// AuthAppConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service. +// AuthAppConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service. func AuthAppConfigFromStruct(cfg *config.Config) map[string]interface{} { appAuthJSON := filepath.Join(defaults.BaseDataPath(), "appauth.json")