Hanzo Space Console

A graphical user interface for Hanzo S3

Object Browser	Creating a bucket	Object Details

Table of Contents

• Hanzo Space Console
  • Install
    • Build from source
  • Setup
    • 1. Create a user console using mc
    • 2. Create a policy for console with admin access to all resources (for testing)
    • 3. Set the policy for the new console user
  • Start Console service:
  • Start Console service with TLS:
  • Connect Console to Hanzo S3 using TLS and a self-signed certificate
• Contribute to console Project

Hanzo Space Console is a library that provides a management and browser UI overlay for the Hanzo S3 Server.

Setup

All console needs is a Hanzo S3 user with admin privileges and URL pointing to your Hanzo S3 deployment.

Note

We don't recommend using Operator Credentials

1. Create a user console using mc

s3 admin user add myminio/
Enter Access Key: console
Enter Secret Key: xxxxxxxx

2. Create a policy for console with admin access to all resources (for testing)

cat > admin.json << EOF
{
	"Version": "2012-10-17",
	"Statement": [{
			"Action": [
				"admin:*"
			],
			"Effect": "Allow",
			"Sid": ""
		},
		{
			"Action": [
                "s3:*"
			],
			"Effect": "Allow",
			"Resource": [
				"arn:aws:s3:::*"
			],
			"Sid": ""
		}
	]
}
EOF

s3 admin policy create myminio/ consoleAdmin admin.json

3. Set the policy for the new console user

s3 admin policy attach myminio consoleAdmin --user=console

Note

Additionally, you can create policies to limit the privileges for other console users, for example, if you want the user to only have access to dashboard, buckets, notifications and watch page, the policy should look like this:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
	"admin:ServerInfo"
      ],
      "Effect": "Allow",
      "Sid": ""
    },
    {
      "Action": [
	"s3:ListenBucketNotification",
	"s3:PutBucketNotification",
	"s3:GetBucketNotification",
	"s3:ListMultipartUploadParts",
	"s3:ListBucketMultipartUploads",
	"s3:ListBucket",
	"s3:HeadBucket",
	"s3:GetObject",
	"s3:GetBucketLocation",
	"s3:AbortMultipartUpload",
	"s3:CreateBucket",
	"s3:PutObject",
	"s3:DeleteObject",
	"s3:DeleteBucket",
	"s3:PutBucketPolicy",
	"s3:DeleteBucketPolicy",
	"s3:GetBucketPolicy"
      ],
      "Effect": "Allow",
      "Resource": [
	"arn:aws:s3:::*"
      ],
      "Sid": ""
    }
  ]
}

Start Console service:

Before running console service, following environment settings must be supplied

# Salt to encrypt JWT payload
export CONSOLE_PBKDF_PASSPHRASE=SECRET

# Required to encrypt JWT payload
export CONSOLE_PBKDF_SALT=SECRET

# Hanzo S3 Endpoint
export CONSOLE_S3_SERVER=http://localhost:9000

Now start the console service.

./console server
2021-01-19 02:36:08.893735 I | 2021/01/19 02:36:08 server.go:129: Serving console at http://localhost:9090

By default console runs on port 9090 this can be changed with --port of your choice.

Start Console service with TLS:

Copy your public.crt and private.key to ~/.console/certs, then:

./console server
2021-01-19 02:36:08.893735 I | 2021/01/19 02:36:08 server.go:129: Serving console at http://[::]:9090
2021-01-19 02:36:08.893735 I | 2021/01/19 02:36:08 server.go:129: Serving console at https://[::]:9443

For advanced users, console has support for multiple certificates to service clients through multiple domains.

Following tree structure is expected for supporting multiple domains:

 certs/
  |
  +- public.crt
  +- private.key
  |
  +- example.com/
  |   |
  |   +- public.crt
  |   +- private.key
  +- foobar.org/
     |
     +- public.crt
     +- private.key
  ...

Connect Console to Hanzo S3 using TLS and a self-signed certificate

Copy the Hanzo S3 ca.crt under ~/.console/certs/CAs, then:

export CONSOLE_S3_SERVER=https://localhost:9000
./console server

You can verify that the apis work by doing the request on localhost:9090/api/v1/...

Debug logging

In some cases it may be convenient to log all HTTP requests. This can be enabled by setting the CONSOLE_DEBUG_LOGLEVEL environment variable to one of the following values:

• 0 (default) uses no logging.
• 1 log single line per request for server-side errors (status-code 5xx).
• 2 log single line per request for client-side and server-side errors (status-code 4xx/5xx).
• 3 log single line per request for all requests (status-code 4xx/5xx).
• 4 log details per request for server-side errors (status-code 5xx).
• 5 log details per request for client-side and server-side errors (status-code 4xx/5xx).
• 6 log details per request for all requests (status-code 4xx/5xx).

A single line logging has the following information:

• Remote endpoint (IP + port) of the request. Note that reverse proxies may hide the actual remote endpoint of the client's browser.
• HTTP method and URL
• Status code of the response (websocket connections are hijacked, so no response is shown)
• Duration of the request

The detailed logging also includes all request and response headers (if any).

Contribute to console Project

Please follow console Contributor's Guide