Function Security

dsl/security.go:324–378

Security defines authentication requirements to access an entire API, service or individual service method. The requirement refers to one or more OAuth2Security, BasicAuthSecurity, APIKeySecurity, BearerSecurity or JWTSecurity security scheme. If the schemes include a BearerSecurity, OAuth2Security

(args ...any)

//	    })
//	})
func Security(args ...any) {
	var dsl func()
	if d, ok := args[len(args)-1].(func()); ok {
		args = args[:len(args)-1]
		dsl = d
	}

	schemes := make([]*expr.SchemeExpr, len(args))
	for i, arg := range args {
		switch val := arg.(type) {
		case string:
			for _, s := range expr.Root.Schemes {
				if s.SchemeName == val {
					schemes[i] = expr.DupScheme(s)
					break
				}
			}
			if schemes[i] == nil {
				eval.ReportError("security scheme %q not found", val)
				return
			}
		case *expr.SchemeExpr:
			if val == nil {
				eval.InvalidArgError("security scheme", val)
				return
			}
			schemes[i] = expr.DupScheme(val)
		default:
			eval.InvalidArgError("security scheme or security scheme name", val)
			return
		}
	}

	security := &expr.SecurityExpr{Schemes: schemes}
	if dsl != nil {
		if !eval.Execute(dsl, security) {
			return
		}
	}

	current := eval.Current()
	switch actual := current.(type) {
	case *expr.MethodExpr:
		actual.Requirements = append(actual.Requirements, security)
	case *expr.ServiceExpr:
		actual.Requirements = append(actual.Requirements, security)
	case *expr.APIExpr:
		actual.Requirements = append(actual.Requirements, security)
	case expr.SecurityHolder:
		actual.AddSecurityRequirement(security)
	default:
		eval.IncompatibleDSL()
		return
	}
}

// NoSecurity removes the need for an endpoint to perform authorization.
//