Add copyright and license header. Update license year

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 RRZE, University Erlangen-Nuremberg
+Copyright (c) 2022 NHR@FAU, University Erlangen-Nuremberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cmd/cc-backend/main.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package main
 
 import (

cmd/gen-keypair/gen-keypair.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package main
 
 import (

docs/JWT-Handling.md

@@ -0,0 +1,46 @@
+## Introduction
+
+ClusterCockpit uses JSON Web Tokens (JWT) for authorization of its APIs.
+JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.
+This information can be verified and trusted because it is digitally signed.
+In ClusterCockpit JWTs are signed using a public/private key pair using ECDSA.
+Because tokens are signed using public/private key pairs, the signature also certifies that only the party holding the private key is the one that signed it.
+Currently JWT tokens in ClusterCockpit not yet expire.
+
+## JWT Payload
+
+You may view the payload of a JWT token at [https://jwt.io/#debugger-io](https://jwt.io/#debugger-io).
+Currently ClusterCockpit sets the following claims:
+* `iat`: Issued at claim. The “iat” claim is used to identify the the time at which the JWT was issued. This claim can be used to determine the age of the JWT.
+* `sub`: Subject claim. Identifies the subject of the JWT, in our case this is the username.
+* `roles`: An array of strings specifying the roles set for the subject.
+
+## Workflow
+
+1. Create a new ECDSA Public/private keypair:
+```
+$ go build ./tools/gen-keypair.go
+$ ./gen-keypair
+```
+2. Add keypair in your `.env` file. A template can be found in `./configs`.
+
+There are two usage scenarios:
+* The APIs are used during a browser session. In this case on login a JWT token is issued on login, that is used by the web frontend to authorize against the GraphQL and REST APIs.
+* The REST API is used outside a browser session, e.g. by scripts. In this case you have to issue a token manually. This possible from within the configuration view or on the command line. It is recommended to issue a JWT token in this case for a special user that only has the `api` role. By using different users for different purposes a fine grained access control and access revocation management is possible.
+
+The token is commonly specified in the Authorization HTTP header using the Bearer schema.
+
+## Setup user and JWT token for REST API authorization
+
+1. Create user:
+```
+$ ./cc-backend --add-user <username>:api:<Password> --no-server
+```
+2. Issue token for user:
+```
+$ ./cc-backend -jwt <username>  -no-server
+```
+3. Use issued token token on client side:
+```
+$ curl -X GET "<API ENDPOINT>" -H "accept: application/json"  -H "Content-Type: application/json"  -H "Authorization: Bearer <JWT TOKEN>"
+```

internal/api/rest.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package api
 
 import (

internal/auth/auth.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package auth
 
 import (

internal/auth/jwt.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package auth
 
 import (

internal/auth/ldap.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package auth
 
 import (

internal/auth/local.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package auth
 
 import (

internal/auth/users.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package auth
 
 import (

internal/config/config.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package config
 
 import (

internal/config/nodelist.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package config
 
 import (

internal/config/nodelist_test.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package config
 
 import (

internal/graph/model/models.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package model
 
 import (

internal/graph/schema.resolvers.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package graph
 
 // This file will be automatically regenerated based on the schema, any resolver implementations

internal/graph/stats.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package graph
 
 import (

internal/metricdata/archive.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package metricdata
 
 import (

internal/metricdata/cc-metric-store.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package metricdata
 
 import (

internal/metricdata/influxdb-v2.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package metricdata
 
 import (

internal/metricdata/metricdata.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package metricdata
 
 import (

internal/metricdata/utils.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package metricdata
 
 import (

internal/repository/dbConnection.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/import.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/init.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/job.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/job_test.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/query.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/repository/tags.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package repository
 
 import (

internal/routerConfig/routes.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package routerConfig
 
 import (

internal/runtimeEnv/setup.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package runtimeEnv
 
 import (

pkg/log/log.go

@@ -1,8 +1,7 @@
-// Provides a simple way of logging with different levels.
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
-// Time/Data are not logged on purpose because systemd adds
+// All rights reserved.
-// them for us.
+// Use of this source code is governed by a MIT-style
-//
+// license that can be found in the LICENSE file.
-// Uses these prefixes: https://www.freedesktop.org/software/systemd/man/sd-daemon.html
 package log
 
 import (
@@ -12,6 +11,12 @@ import (
 	"os"
 )
 
+// Provides a simple way of logging with different levels.
+// Time/Data are not logged on purpose because systemd adds
+// them for us.
+//
+// Uses these prefixes: https://www.freedesktop.org/software/systemd/man/sd-daemon.html
+
 var (
 	DebugWriter io.Writer = os.Stderr
 	InfoWriter  io.Writer = os.Stderr

pkg/schema/float.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package schema
 
 import (

pkg/schema/job.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package schema
 
 import (

pkg/schema/metrics.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package schema
 
 import (

web/web.go

@@ -1,3 +1,7 @@
+// Copyright (C) 2022 NHR@FAU, University Erlangen-Nuremberg.
+// All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
 package web
 
 import (