mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 04:20:11 +00:00
115 lines
3.8 KiB
Go
115 lines
3.8 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
||
// SPDX-License-Identifier: MIT
|
||
|
||
package v3
|
||
|
||
import (
|
||
"context"
|
||
"crypto/sha256"
|
||
"strings"
|
||
|
||
"github.com/pb33f/libopenapi/datamodel/low"
|
||
"github.com/pb33f/libopenapi/index"
|
||
"github.com/pb33f/libopenapi/orderedmap"
|
||
"github.com/pb33f/libopenapi/utils"
|
||
"gopkg.in/yaml.v3"
|
||
)
|
||
|
||
// SecurityScheme represents a low-level OpenAPI 3+ SecurityScheme object.
|
||
//
|
||
// Defines a security scheme that can be used by the operations.
|
||
//
|
||
// Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter),
|
||
// mutual TLS (use of a client certificate), OAuth2’s common flows (implicit, password, client credentials and
|
||
// authorization code) as defined in RFC6749 (https://www.rfc-editor.org/rfc/rfc6749), and OpenID Connect Discovery.
|
||
// Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice.
|
||
// Recommended for most use case is Authorization Code Grant flow with PKCE.
|
||
// - https://spec.openapis.org/oas/v3.1.0#security-scheme-object
|
||
type SecurityScheme struct {
|
||
Type low.NodeReference[string]
|
||
Description low.NodeReference[string]
|
||
Name low.NodeReference[string]
|
||
In low.NodeReference[string]
|
||
Scheme low.NodeReference[string]
|
||
BearerFormat low.NodeReference[string]
|
||
Flows low.NodeReference[*OAuthFlows]
|
||
OpenIdConnectUrl low.NodeReference[string]
|
||
Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]]
|
||
KeyNode *yaml.Node
|
||
RootNode *yaml.Node
|
||
*low.Reference
|
||
low.NodeMap
|
||
}
|
||
|
||
// GetRootNode returns the root yaml node of the SecurityScheme object.
|
||
func (ss *SecurityScheme) GetRootNode() *yaml.Node {
|
||
return ss.RootNode
|
||
}
|
||
|
||
// GetKeyNode returns the key yaml node of the SecurityScheme object.
|
||
func (ss *SecurityScheme) GetKeyNode() *yaml.Node {
|
||
return ss.KeyNode
|
||
}
|
||
|
||
// FindExtension attempts to locate an extension using the supplied key.
|
||
func (ss *SecurityScheme) FindExtension(ext string) *low.ValueReference[*yaml.Node] {
|
||
return low.FindItemInOrderedMap(ext, ss.Extensions)
|
||
}
|
||
|
||
// GetExtensions returns all SecurityScheme extensions and satisfies the low.HasExtensions interface.
|
||
func (ss *SecurityScheme) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] {
|
||
return ss.Extensions
|
||
}
|
||
|
||
// Build will extract OAuthFlows and extensions from the node.
|
||
func (ss *SecurityScheme) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
|
||
ss.KeyNode = keyNode
|
||
root = utils.NodeAlias(root)
|
||
ss.RootNode = root
|
||
utils.CheckForMergeNodes(root)
|
||
ss.Reference = new(low.Reference)
|
||
ss.Nodes = low.ExtractNodes(ctx, root)
|
||
ss.Extensions = low.ExtractExtensions(root)
|
||
low.ExtractExtensionNodes(ctx, ss.Extensions, ss.Nodes)
|
||
|
||
oa, oaErr := low.ExtractObject[*OAuthFlows](ctx, OAuthFlowsLabel, root, idx)
|
||
if oaErr != nil {
|
||
return oaErr
|
||
}
|
||
if oa.Value != nil {
|
||
ss.Flows = oa
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// Hash will return a consistent SHA256 Hash of the SecurityScheme object
|
||
func (ss *SecurityScheme) Hash() [32]byte {
|
||
var f []string
|
||
if !ss.Type.IsEmpty() {
|
||
f = append(f, ss.Type.Value)
|
||
}
|
||
if !ss.Description.IsEmpty() {
|
||
f = append(f, ss.Description.Value)
|
||
}
|
||
if !ss.Name.IsEmpty() {
|
||
f = append(f, ss.Name.Value)
|
||
}
|
||
if !ss.In.IsEmpty() {
|
||
f = append(f, ss.In.Value)
|
||
}
|
||
if !ss.Scheme.IsEmpty() {
|
||
f = append(f, ss.Scheme.Value)
|
||
}
|
||
if !ss.BearerFormat.IsEmpty() {
|
||
f = append(f, ss.BearerFormat.Value)
|
||
}
|
||
if !ss.Flows.IsEmpty() {
|
||
f = append(f, low.GenerateHashString(ss.Flows.Value))
|
||
}
|
||
if !ss.OpenIdConnectUrl.IsEmpty() {
|
||
f = append(f, ss.OpenIdConnectUrl.Value)
|
||
}
|
||
f = append(f, low.HashExtensions(ss.Extensions)...)
|
||
return sha256.Sum256([]byte(strings.Join(f, "|")))
|
||
}
|