debian-forge-composer/vendor/github.com/openshift-online/ocm-sdk-go/logging/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

65 lines
2.5 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 the definition of the logger interface that is used by the client.
package logging
import (
"context"
)
// Logger is the interface that must be implemented by objects that are used for logging by the
// client. By default the client uses a logger based on the `glog` package, but that can be changed
// using the `Logger` method of the builder.
//
// Note that the context is optional in most of the methods of the SDK, so implementations of this
// interface must accept and handle smoothly calls to the Debug, Info, Warn and Error methods where
// the ctx parameter is nil.
type Logger interface {
// DebugEnabled returns true if the debug level is enabled.
DebugEnabled() bool
// InfoEnabled returns true if the information level is enabled.
InfoEnabled() bool
// WarnEnabled returns true if the warning level is enabled.
WarnEnabled() bool
// ErrorEnabled returns true if the error level is enabled.
ErrorEnabled() bool
// Debug sends to the log a debug message formatted using the fmt.Sprintf function and the
// given format and arguments.
Debug(ctx context.Context, format string, args ...interface{})
// Info sends to the log an information message formatted using the fmt.Sprintf function and
// the given format and arguments.
Info(ctx context.Context, format string, args ...interface{})
// Warn sends to the log a warning message formatted using the fmt.Sprintf function and the
// given format and arguments.
Warn(ctx context.Context, format string, args ...interface{})
// Error sends to the log an error message formatted using the fmt.Sprintf function and the
// given format and arguments.
Error(ctx context.Context, format string, args ...interface{})
// Fatal sends to the log an error message formatted using the fmt.Sprintf function and the
// given format and arguments; and then executes an os.Exit(1)
// Fatal level is always enabled
Fatal(ctx context.Context, format string, args ...interface{})
}