v1

package

v1.16.0 Latest Latest Go to latest Published: Dec 15, 2025 License: Apache-2.0 Imports: 32 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/device-management-toolkit/console

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ErrorResponse(c *gin.Context, err error)
func NewAmtRoutes(handler *gin.RouterGroup, d devices.Feature, amt amtexplorer.Feature, ...)
func NewCIRACertRoutes(handler *gin.RouterGroup, l logger.Interface)
func NewCIRACertRoutesWithReader(handler *gin.RouterGroup, l logger.Interface, certReader CertReader)
func NewCIRAConfigRoutes(handler *gin.RouterGroup, t ciraconfigs.Feature, l logger.Interface)
func NewDeviceRoutes(handler *gin.RouterGroup, t devices.Feature, l logger.Interface)
func NewDomainRoutes(handler *gin.RouterGroup, t domains.Feature, l logger.Interface)
func NewIEEE8021xConfigRoutes(handler *gin.RouterGroup, t ieee8021xconfigs.Feature, l logger.Interface)
func NewProfileRoutes(handler *gin.RouterGroup, t profiles.Feature, l logger.Interface)
func NewWirelessConfigRoutes(handler *gin.RouterGroup, t wificonfigs.Feature, l logger.Interface)
func RepositoryError(status string) error
type CertReader
type DomainCountResponse
type FileCertReader
- func (f *FileCertReader) ReadCert() ([]byte, error)
type LoginRoute
- func NewLoginRoute(configData *config.Config) *LoginRoute
- func (lr LoginRoute) JWTAuthMiddleware() gin.HandlerFunc
- func (lr LoginRoute) Login(c *gin.Context)
type OData
type VersionRoute
- func NewVersionRoute(configData *config.Config) *VersionRoute
- func (vr VersionRoute) FetchLatestRelease(c *gin.Context, repo string) (*github.Release, error)
- func (vr VersionRoute) LatestReleaseHandler(c *gin.Context)
type WirelessConfigRoutes

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrGithub        = consoleerrors.CreateConsoleError("LatestReleaseHandler")
	ErrFailedToFetch = errors.New("repositoryError")
)

View Source

var ErrLogin = consoleerrors.CreateConsoleError("LoginHandler")

View Source

var ErrValidation8021xConfig = dto.NotValidError{Console: consoleerrors.CreateConsoleError("8021xConfigAPI")}

View Source

var ErrValidationDevices = dto.NotValidError{Console: consoleerrors.CreateConsoleError("ProfileAPI")}

View Source

var ErrValidationDomains = dto.NotValidError{Console: consoleerrors.CreateConsoleError("DomainsAPI")}

View Source

var ErrValidationProfile = dto.NotValidError{Console: consoleerrors.CreateConsoleError("ProfileAPI")}

View Source

var ErrValidationWifiConfig = dto.NotValidError{Console: consoleerrors.CreateConsoleError("WifiConfigsAPI")}

Functions ¶

func ErrorResponse ¶

func ErrorResponse(c *gin.Context, err error)

func NewAmtRoutes ¶

func NewAmtRoutes(handler *gin.RouterGroup, d devices.Feature, amt amtexplorer.Feature, e export.Exporter, l logger.Interface)

func NewCIRACertRoutes ¶

func NewCIRACertRoutes(handler *gin.RouterGroup, l logger.Interface)

func NewCIRACertRoutesWithReader ¶

func NewCIRACertRoutesWithReader(handler *gin.RouterGroup, l logger.Interface, certReader CertReader)

NewCIRACertRoutesWithReader creates routes with a custom cert reader (for testing).

func NewCIRAConfigRoutes ¶

func NewCIRAConfigRoutes(handler *gin.RouterGroup, t ciraconfigs.Feature, l logger.Interface)

func NewDeviceRoutes ¶

func NewDeviceRoutes(handler *gin.RouterGroup, t devices.Feature, l logger.Interface)

func NewDomainRoutes ¶

func NewDomainRoutes(handler *gin.RouterGroup, t domains.Feature, l logger.Interface)

func NewIEEE8021xConfigRoutes ¶

func NewIEEE8021xConfigRoutes(handler *gin.RouterGroup, t ieee8021xconfigs.Feature, l logger.Interface)

func NewProfileRoutes ¶

func NewProfileRoutes(handler *gin.RouterGroup, t profiles.Feature, l logger.Interface)

func NewWirelessConfigRoutes ¶

func NewWirelessConfigRoutes(handler *gin.RouterGroup, t wificonfigs.Feature, l logger.Interface)

func RepositoryError ¶

func RepositoryError(status string) error

Types ¶

type CertReader ¶

type CertReader interface {
	ReadCert() ([]byte, error)
}

CertReader defines the interface for reading certificate files.

type DomainCountResponse ¶

type DomainCountResponse struct {
	Count int          `json:"totalCount"`
	Data  []dto.Domain `json:"data"`
}

type FileCertReader ¶

type FileCertReader struct {
	Path string
}

FileCertReader reads certificates from the filesystem.

func (*FileCertReader) ReadCert ¶

func (f *FileCertReader) ReadCert() ([]byte, error)

ReadCert reads the certificate from the configured file path.

type LoginRoute ¶

type LoginRoute struct {
	Config   *config.Config
	Verifier *oidc.IDTokenVerifier
}

func NewLoginRoute ¶

func NewLoginRoute(configData *config.Config) *LoginRoute

NewVersionRoute creates a new version route

func (LoginRoute) JWTAuthMiddleware ¶

func (lr LoginRoute) JWTAuthMiddleware() gin.HandlerFunc

JWT Middleware

func (lr LoginRoute) Login(c *gin.Context)

Login checks configured credentials and returns a JWT token for basic auth

type OData ¶

type OData struct {
	Top   int  `form:"$top,default=25"`
	Skip  int  `form:"$skip"`
	Count bool `form:"$count"`
}

type VersionRoute ¶

type VersionRoute struct {
	Config *config.Config
}

func NewVersionRoute ¶

func NewVersionRoute(configData *config.Config) *VersionRoute

NewVersionRoute creates a new version route

func (VersionRoute) FetchLatestRelease ¶

func (vr VersionRoute) FetchLatestRelease(c *gin.Context, repo string) (*github.Release, error)

FetchLatestRelease fetches the latest release information from GitHub API

func (VersionRoute) LatestReleaseHandler ¶

func (vr VersionRoute) LatestReleaseHandler(c *gin.Context)

LatestReleaseHandler is the Gin handler function to check for the latest release

type WirelessConfigRoutes ¶

type WirelessConfigRoutes struct {
	// contains filtered or unexported fields
}

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func ErrorResponse ¶

func NewAmtRoutes ¶

func NewCIRACertRoutes ¶

func NewCIRACertRoutesWithReader ¶

func NewCIRAConfigRoutes ¶

func NewDeviceRoutes ¶

func NewDomainRoutes ¶

func NewIEEE8021xConfigRoutes ¶

func NewProfileRoutes ¶

func NewWirelessConfigRoutes ¶

func RepositoryError ¶

Types ¶

type CertReader ¶

type DomainCountResponse ¶

type FileCertReader ¶

func (*FileCertReader) ReadCert ¶

type LoginRoute ¶

func NewLoginRoute ¶

func (LoginRoute) JWTAuthMiddleware ¶

func (LoginRoute) Login ¶

type OData ¶

type VersionRoute ¶

func NewVersionRoute ¶

func (VersionRoute) FetchLatestRelease ¶

func (VersionRoute) LatestReleaseHandler ¶

type WirelessConfigRoutes ¶

Source Files ¶