server

Documentation

Overview

Package server contains implementation of REST API server (HTTPServer) for the LDAP proxy.

Generated documentation is available at: https://godoc.org/github.com/RedHatInsights/insights-operator-ldapauth/server

Documentation in literate-programming-style is available at: https://redhatinsights.github.io/insights-operator-ldapauth/packages/server/server.html

Index

• Variables
• type Server
  • func (s *Server) HandleHTTP(w http.ResponseWriter, req *http.Request)
  • func (s *Server) Initialize()
  • func (s *Server) JWTAuthentication(next http.Handler) http.Handler
  • func (s *Server) Login(writer http.ResponseWriter, request *http.Request)
• type Status

Variables

var APIPrefix = env.GetEnv("CONTROLLER_PREFIX", "/api/v1/")

APIPrefix is appended before all REST API endpoint addresses

var OkStatus = Status{
	Status: "ok",
}

OkStatus prepared successful response

Types

type Server

type Server struct {
	Address     string
	LDAP        string
	Proxy       string
	ProxyPrefix string
	Transport   http.RoundTripper
}

Server basic configuration of server

func (*Server) HandleHTTP

func (s *Server) HandleHTTP(w http.ResponseWriter, req *http.Request)

HandleHTTP handle all routes, used for proxying them to controller

func (*Server) Initialize

func (s *Server) Initialize()

Initialize main function that start server

func (*Server) JWTAuthentication

func (s *Server) JWTAuthentication(next http.Handler) http.Handler

JWTAuthentication - middleware for authenticate user by Token

func (*Server) Login

func (s *Server) Login(writer http.ResponseWriter, request *http.Request)

Login handler for login route

type Status

type Status struct {
	Status string `json:"status"`
}

Status structure for RestAPI response