Documentation
¶
Overview ¶
Package server provides reusable scaffolding for building CEDAR command servers (daemons that accept connections, authenticate, and dispatch HTCondor commands). It complements the client-focused packages in this module.
Two kinds of command handlers are supported:
- Authenticated commands: the client opens the exchange with a DC_AUTHENTICATE command and a security ClassAd that carries the real command (e.g. CCB_REGISTER). The server performs the security handshake and dispatches on the real command.
- Raw commands: the client sends a bare command integer with no security handshake (e.g. CCB_REVERSE_CONNECT, which HTCondor registers as ALLOW and sends via the "raw" command protocol). These are dispatched directly with no authentication.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Conn ¶
type Conn struct {
// Stream is the CEDAR stream for the connection. For authenticated
// commands it is authenticated (and possibly encrypted) by the time the
// handler runs; for raw commands it is plaintext.
Stream *stream.Stream
// Command is the real HTCondor command being dispatched.
Command int
// Negotiation is the result of the security handshake, or nil for raw
// commands.
Negotiation *security.SecurityNegotiation
// Message is the inbound Message the leading command integer was read
// from. Raw-command handlers read their payload (e.g. a ClassAd) from
// this message; authenticated handlers normally start a fresh message.
Message *message.Message
// RemoteAddr is the peer's network address.
RemoteAddr string
}
Conn is the per-connection context handed to a command handler.
func (*Conn) PeerVersion ¶
PeerVersion returns the peer's reported $CondorVersion$ string, or "" if it was not exchanged (e.g. for raw commands).
type HandlerFunc ¶
HandlerFunc handles a single dispatched command. Returning an error closes the connection unless the handler has taken ownership of it (see KeepOpen).
type Server ¶
type Server struct {
// SecurityConfig is used for the server side of the security handshake on
// authenticated commands. It must be non-nil if any authenticated handler
// is registered.
SecurityConfig *security.SecurityConfig
// contains filtered or unexported fields
}
Server accepts CEDAR connections and dispatches commands to handlers.
func New ¶
func New(secConfig *security.SecurityConfig) *Server
New creates a Server with the given server-side security configuration.
func (*Server) Handle ¶
func (s *Server) Handle(command int, fn HandlerFunc)
Handle registers an authenticated handler for a command.
func (*Server) HandleRaw ¶
func (s *Server) HandleRaw(command int, fn HandlerFunc)
HandleRaw registers a handler for a raw (un-authenticated) command. The command integer arrives with no preceding DC_AUTHENTICATE.
Source Files