http

Documentation

Overview

Copyright 2017 Northern.tech AS

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.

Copyright 2023 Northern.tech AS

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.

Copyright 2021 Northern.tech AS

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.

Index

• Variables
• func ExtractResourceAction(r *rest.Request) (*authz.Action, error)
• func IsVerificationEndpoint(r *rest.Request) bool
• type ApiHandler
  • func NewUserAdmApiHandlers(userAdm useradm.App, db store.DataStore, jwth map[int]jwt.Handler, ...) ApiHandler
• type Config
• type UserAdmApiHandlers
  • func (u *UserAdmApiHandlers) AddUserHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) AliveHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) AuthLoginHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) AuthLogoutHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) AuthVerifyHandler(w rest.ResponseWriter, r *rest.Request)
  • func (i *UserAdmApiHandlers) Build(authorizer authz.Authorizer) (http.Handler, error)
  • func (u *UserAdmApiHandlers) CreateTenantHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) CreateTenantUserHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) DeleteTenantUserHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) DeleteTokenHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) DeleteTokensHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) DeleteUserHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetPlanBindingHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetPlansHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetSettingsHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetSettingsMeHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetTenantUsersHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetTokensHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetUserHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) GetUsersHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) HealthHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) IssueTokenHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) SaveSettingsHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) SaveSettingsMeHandler(w rest.ResponseWriter, r *rest.Request)
  • func (u *UserAdmApiHandlers) UpdateUserHandler(w rest.ResponseWriter, r *rest.Request)

Variables

var (
	ErrAuthHeader   = errors.New("invalid or missing auth header")
	ErrUserNotFound = errors.New("user not found")
)

Functions

func ExtractResourceAction

func ExtractResourceAction(r *rest.Request) (*authz.Action, error)

ExtractResourceAction extracts resource action from the request url

func IsVerificationEndpoint

func IsVerificationEndpoint(r *rest.Request) bool

Types

type ApiHandler

type ApiHandler interface {
	// produce a rest.App with routing setup or an error
	Build(authz.Authorizer) (http.Handler, error)
}

thin API handler interface

func NewUserAdmApiHandlers

func NewUserAdmApiHandlers(
	userAdm useradm.App,
	db store.DataStore,
	jwth map[int]jwt.Handler,
	config Config,
) ApiHandler

return an ApiHandler for user administration and authentiacation app

type Config

type Config struct {
	// maximum expiration time for Personal Access Token
	TokenMaxExpSeconds int

	JWTFallback jwt.Handler
}

type UserAdmApiHandlers

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

func (*UserAdmApiHandlers) AddUserHandler

func (u *UserAdmApiHandlers) AddUserHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) AliveHandler

func (u *UserAdmApiHandlers) AliveHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) AuthLoginHandler

func (u *UserAdmApiHandlers) AuthLoginHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) AuthLogoutHandler

func (u *UserAdmApiHandlers) AuthLogoutHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) AuthVerifyHandler

func (u *UserAdmApiHandlers) AuthVerifyHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) Build

func (i *UserAdmApiHandlers) Build(authorizer authz.Authorizer) (http.Handler, error)

func (*UserAdmApiHandlers) CreateTenantHandler

func (u *UserAdmApiHandlers) CreateTenantHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) CreateTenantUserHandler

func (u *UserAdmApiHandlers) CreateTenantUserHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) DeleteTenantUserHandler

func (u *UserAdmApiHandlers) DeleteTenantUserHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) DeleteTokenHandler

func (u *UserAdmApiHandlers) DeleteTokenHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) DeleteTokensHandler

func (u *UserAdmApiHandlers) DeleteTokensHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) DeleteUserHandler

func (u *UserAdmApiHandlers) DeleteUserHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetPlanBindingHandler

func (u *UserAdmApiHandlers) GetPlanBindingHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetPlansHandler

func (u *UserAdmApiHandlers) GetPlansHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetSettingsHandler

func (u *UserAdmApiHandlers) GetSettingsHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetSettingsMeHandler

func (u *UserAdmApiHandlers) GetSettingsMeHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetTenantUsersHandler

func (u *UserAdmApiHandlers) GetTenantUsersHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetTokensHandler

func (u *UserAdmApiHandlers) GetTokensHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetUserHandler

func (u *UserAdmApiHandlers) GetUserHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) GetUsersHandler

func (u *UserAdmApiHandlers) GetUsersHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) HealthHandler

func (u *UserAdmApiHandlers) HealthHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) IssueTokenHandler

func (u *UserAdmApiHandlers) IssueTokenHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) SaveSettingsHandler

func (u *UserAdmApiHandlers) SaveSettingsHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) SaveSettingsMeHandler

func (u *UserAdmApiHandlers) SaveSettingsMeHandler(w rest.ResponseWriter, r *rest.Request)

func (*UserAdmApiHandlers) UpdateUserHandler

func (u *UserAdmApiHandlers) UpdateUserHandler(w rest.ResponseWriter, r *rest.Request)