debian-forge-composer/vendor/github.com/openshift-online/ocm-sdk-go/logging/go_logger.go
sanne 4a057bf3d5 auth: OpenID/OAUth2 middleware
2 configurations for the listeners are now possible:
- enableJWT=false with client ssl auth
- enableJWT=true with https

Actual verification of the tokens is handled by
https://github.com/openshift-online/ocm-sdk-go.

An authentication handler is run as the top level handler, before any
routing is done. Routes which do not require authentication should be
listed as exceptions.

Authentication can be restricted using an ACL file which allows
filtering based on JWT claims. For more information see the inline
comments in ocm-sdk/authentication.

As an added quirk the `-v` flag for the osbuild-composer executable was
changed to `-verbose` to avoid flag collision with glog which declares
the `-v` flag in the package `init()` function. The ocm-sdk depends on
glog and pulls it in.
2021-09-04 02:48:52 +02:00

165 lines
4.6 KiB
Go

/*
Copyright (c) 2018 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// This file contains a logger that uses the Go `log` package.
package logging
import (
"context"
"fmt"
"log"
"os"
)
// GoLoggerBuilder contains the configuration and logic needed to build a logger that uses the Go
// `log` package. Don't create instances of this type directly, use the NewGoLoggerBuilder function
// instead.
type GoLoggerBuilder struct {
debugEnabled bool
infoEnabled bool
warnEnabled bool
errorEnabled bool
}
// GoLogger is a logger that uses the Go `log` package.
type GoLogger struct {
debugEnabled bool
infoEnabled bool
warnEnabled bool
errorEnabled bool
}
// NewGoLoggerBuilder creates a builder that knows how to build a logger that uses the Go `log`
// package. By default these loggers will have enabled the information, warning and error levels
func NewGoLoggerBuilder() *GoLoggerBuilder {
// Allocate the object:
builder := new(GoLoggerBuilder)
// Set default values:
builder.debugEnabled = false
builder.infoEnabled = true
builder.warnEnabled = true
builder.errorEnabled = true
return builder
}
// Debug enables or disables the debug level.
func (b *GoLoggerBuilder) Debug(flag bool) *GoLoggerBuilder {
b.debugEnabled = flag
return b
}
// Info enables or disables the information level.
func (b *GoLoggerBuilder) Info(flag bool) *GoLoggerBuilder {
b.infoEnabled = flag
return b
}
// Warn enables or disables the warning level.
func (b *GoLoggerBuilder) Warn(flag bool) *GoLoggerBuilder {
b.warnEnabled = flag
return b
}
// Error enables or disables the error level.
func (b *GoLoggerBuilder) Error(flag bool) *GoLoggerBuilder {
b.errorEnabled = flag
return b
}
// Build creates a new logger using the configuration stored in the builder.
func (b *GoLoggerBuilder) Build() (logger *GoLogger, err error) {
// Allocate and populate the object:
logger = new(GoLogger)
logger.debugEnabled = b.debugEnabled
logger.infoEnabled = b.infoEnabled
logger.warnEnabled = b.warnEnabled
logger.errorEnabled = b.errorEnabled
return
}
// DebugEnabled returns true iff the debug level is enabled.
func (l *GoLogger) DebugEnabled() bool {
return l.debugEnabled
}
// InfoEnabled returns true iff the information level is enabled.
func (l *GoLogger) InfoEnabled() bool {
return l.infoEnabled
}
// WarnEnabled returns true iff the warning level is enabled.
func (l *GoLogger) WarnEnabled() bool {
return l.warnEnabled
}
// ErrorEnabled returns true iff the error level is enabled.
func (l *GoLogger) ErrorEnabled() bool {
return l.errorEnabled
}
// Debug sends to the log a debug message formatted using the fmt.Sprintf function and the given
// format and arguments.
func (l *GoLogger) Debug(ctx context.Context, format string, args ...interface{}) {
if l.debugEnabled {
msg := fmt.Sprintf(format, args...)
// #nosec G104
log.Output(1, msg)
}
}
// Info sends to the log an information message formatted using the fmt.Sprintf function and the
// given format and arguments.
func (l *GoLogger) Info(ctx context.Context, format string, args ...interface{}) {
if l.infoEnabled {
msg := fmt.Sprintf(format, args...)
// #nosec G104
log.Output(1, msg)
}
}
// Warn sends to the log a warning message formatted using the fmt.Sprintf function and the given
// format and arguments.
func (l *GoLogger) Warn(ctx context.Context, format string, args ...interface{}) {
if l.warnEnabled {
msg := fmt.Sprintf(format, args...)
// #nosec G104
log.Output(1, msg)
}
}
// Error sends to the log an error message formatted using the fmt.Sprintf function and the given
// format and arguments.
func (l *GoLogger) Error(ctx context.Context, format string, args ...interface{}) {
if l.errorEnabled {
msg := fmt.Sprintf(format, args...)
// #nosec G104
log.Output(1, msg)
}
}
// Fatal sends to the log an error message formatted using the fmt.Sprintf function and the given
// format and arguments. After that it will os.Exit(1)
// This level is always enabled
func (l *GoLogger) Fatal(ctx context.Context, format string, args ...interface{}) {
msg := fmt.Sprintf(format, args...)
// #nosec G104
log.Output(1, msg)
os.Exit(1)
}