grim/hgkeeper

Move the http server from the hgweb package to the http package

2022-03-07, Gary Kramlich
00b9a40ac18c
Parents 578a90d306a3
Children 84baf61558d2
Move the http server from the hgweb package to the http package
6 files changed, 200 insertions(+), 200 deletions(-)
  • +0 -119
    hgweb/logger.go
  • +0 -75
    hgweb/server.go
  • +1 -1
    http/authorized_keys.go
  • +119 -0
    http/logger.go
  • +75 -0
    http/server.go
  • +5 -5
    serve/command.go
    • --- a/hgweb/logger.go Mon Mar 07 01:52:42 2022 -0600
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,119 +0,0 @@
    -package hgweb
    -
    -import (
    - "net/http"
    - "strings"
    - "time"
    -
    - log "github.com/sirupsen/logrus"
    -)
    -
    -type loggerResponseWriter struct {
    - w http.ResponseWriter
    - wroteHeader bool
    - statusCode int
    - written int64
    -}
    -
    -var _ http.ResponseWriter = (*loggerResponseWriter)(nil)
    -
    -func (w *loggerResponseWriter) Header() http.Header {
    - return w.w.Header()
    -}
    -
    -func (w *loggerResponseWriter) Write(data []byte) (int, error) {
    - if !w.wroteHeader {
    - w.WriteHeader(http.StatusOK)
    - }
    -
    - n, err := w.w.Write(data)
    - w.written += int64(n)
    -
    - return n, err
    -}
    -
    -func (w *loggerResponseWriter) WriteHeader(statusCode int) {
    - if !w.wroteHeader {
    - w.statusCode = statusCode
    - w.wroteHeader = true
    - }
    -
    - w.w.WriteHeader(w.statusCode)
    -}
    -
    -func (w *loggerResponseWriter) StatusCode() int {
    - return w.statusCode
    -}
    -
    -func (w *loggerResponseWriter) Written() int64 {
    - return w.written
    -}
    -
    -func getAddr(r *http.Request) string {
    - // check for the X-Forwarded-For header and use if it we have it
    - if fwd := r.Header.Get("X-Forwarded-For"); fwd != "" {
    - return fwd
    - }
    -
    - // Request.RemoteAddr is ipv4:port or [ipv6]:port so we have to trim off
    - // the extra bits.
    - addr := r.RemoteAddr
    -
    - // we use LastIndex so we can parse IPv6 addresses
    - if idx := strings.LastIndex(addr, ":"); idx != -1 {
    - addr = addr[:idx]
    - }
    -
    - // if the ipv6 was wrapped in [] we need to unwrap it
    - if idx := strings.Index(addr, "]"); idx != -1 {
    - addr = addr[1:idx]
    - }
    -
    - return addr
    -}
    -
    -func Logger(h http.Handler) http.Handler {
    - return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    - rw := &loggerResponseWriter{
    - w: w,
    - }
    -
    - defer func() {
    - // implement the NCSA Combined Log Format
    - // http://publib.boulder.ibm.com/tividd/td/ITWSA/ITWSA_info45/en_US/HTML/guide/c-logs.html#combined
    -
    - addr := getAddr(r)
    -
    - username := "-"
    - if user, _, ok := r.BasicAuth(); ok && username != "" {
    - username = user
    - }
    -
    - referer := r.Referer()
    - if referer == "" {
    - referer = "-"
    - }
    -
    - userAgent := r.UserAgent()
    - if userAgent == "" {
    - userAgent = "-"
    - }
    -
    - log.Infof(
    - "%s - %s [%s] \"%s %s %s\" %d %d %q %q\n",
    - addr,
    - username,
    - time.Now().Format("02/Jan/2006:15:04:05 -0700"),
    - r.Method,
    - r.URL.Path,
    - r.Proto,
    - rw.StatusCode(),
    - rw.Written(),
    - referer,
    - userAgent,
    - )
    - }()
    -
    - h.ServeHTTP(rw, r)
    - })
    -}
    --- a/hgweb/server.go Mon Mar 07 01:52:42 2022 -0600
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,75 +0,0 @@
    -package hgweb
    -
    -import (
    - "net/http"
    - "path/filepath"
    -
    - log "github.com/sirupsen/logrus"
    - "keep.imfreedom.org/grim/hgkeeper/hg"
    - hgkHttp "keep.imfreedom.org/grim/hgkeeper/http"
    -)
    -
    -type Server struct {
    - listenAddr string
    - server *http.Server
    -
    - hgw *HGWeb
    -
    - externalHostname string
    - externalPort string
    -}
    -
    -func NewServer(listenAddr string, externalHostname, externalPort string) (*Server, error) {
    - return &Server{
    - listenAddr: listenAddr,
    - server: &http.Server{
    - Addr: listenAddr,
    - },
    - hgw: New(),
    - externalHostname: externalHostname,
    - externalPort: externalPort,
    - }, nil
    -}
    -
    -func (s *Server) Listen() error {
    - templatesDir, err := hg.TemplatesDir()
    - if err != nil {
    - return err
    - }
    - staticPath := filepath.Join(templatesDir, "static")
    - log.Infof("serving static files from %s", staticPath)
    - fileServer := http.FileServer(http.Dir(staticPath))
    -
    - mux := http.NewServeMux()
    -
    - if s.externalHostname != "" {
    - mux.Handle("/ssh/authorized_keys", hgkHttp.AuthorizedKeysHandler(s.externalHostname, s.externalPort))
    - log.Infof("added /ssh/authorized_keys endpoint with external hostname %s and export port %s", s.externalHostname, s.externalPort)
    - } else {
    - log.Infof("no external hostname specified, not adding /ssh/authorized_keys endpoint")
    - }
    -
    - mux.Handle("/static/", http.StripPrefix("/static", fileServer))
    -
    - hgwHandler, err := s.hgw.Handler()
    - if err != nil {
    - return err
    - }
    - mux.Handle("/", hgwHandler)
    -
    - s.server.Handler = Logger(mux)
    -
    - log.Infof("http listening on %s", s.listenAddr)
    -
    - return s.server.ListenAndServe()
    -}
    -
    -func (s *Server) Close() {
    - if err := s.hgw.Close(); err != nil {
    - log.Warnf("failed to close hgweb: %v", err)
    - }
    -
    - if err := s.server.Close(); err != nil {
    - log.Warnf("failed to shutdown http server: %v", err)
    - }
    -}
    --- a/http/authorized_keys.go Mon Mar 07 01:52:42 2022 -0600
    +++ b/http/authorized_keys.go Mon Mar 07 01:55:50 2022 -0600
    @@ -10,7 +10,7 @@
    "keep.imfreedom.org/grim/hgkeeper/access"
    )
    -func AuthorizedKeysHandler(externalHostname, externalPort string) http.Handler {
    +func authorizedKeysHandler(externalHostname, externalPort string) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    fp := r.URL.Query().Get("fp")
    if fp == "" {
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/http/logger.go Mon Mar 07 01:55:50 2022 -0600
    @@ -0,0 +1,119 @@
    +package http
    +
    +import (
    + "net/http"
    + "strings"
    + "time"
    +
    + log "github.com/sirupsen/logrus"
    +)
    +
    +type loggerResponseWriter struct {
    + w http.ResponseWriter
    + wroteHeader bool
    + statusCode int
    + written int64
    +}
    +
    +var _ http.ResponseWriter = (*loggerResponseWriter)(nil)
    +
    +func (w *loggerResponseWriter) Header() http.Header {
    + return w.w.Header()
    +}
    +
    +func (w *loggerResponseWriter) Write(data []byte) (int, error) {
    + if !w.wroteHeader {
    + w.WriteHeader(http.StatusOK)
    + }
    +
    + n, err := w.w.Write(data)
    + w.written += int64(n)
    +
    + return n, err
    +}
    +
    +func (w *loggerResponseWriter) WriteHeader(statusCode int) {
    + if !w.wroteHeader {
    + w.statusCode = statusCode
    + w.wroteHeader = true
    + }
    +
    + w.w.WriteHeader(w.statusCode)
    +}
    +
    +func (w *loggerResponseWriter) StatusCode() int {
    + return w.statusCode
    +}
    +
    +func (w *loggerResponseWriter) Written() int64 {
    + return w.written
    +}
    +
    +func getAddr(r *http.Request) string {
    + // check for the X-Forwarded-For header and use if it we have it
    + if fwd := r.Header.Get("X-Forwarded-For"); fwd != "" {
    + return fwd
    + }
    +
    + // Request.RemoteAddr is ipv4:port or [ipv6]:port so we have to trim off
    + // the extra bits.
    + addr := r.RemoteAddr
    +
    + // we use LastIndex so we can parse IPv6 addresses
    + if idx := strings.LastIndex(addr, ":"); idx != -1 {
    + addr = addr[:idx]
    + }
    +
    + // if the ipv6 was wrapped in [] we need to unwrap it
    + if idx := strings.Index(addr, "]"); idx != -1 {
    + addr = addr[1:idx]
    + }
    +
    + return addr
    +}
    +
    +func Logger(h http.Handler) http.Handler {
    + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    + rw := &loggerResponseWriter{
    + w: w,
    + }
    +
    + defer func() {
    + // implement the NCSA Combined Log Format
    + // http://publib.boulder.ibm.com/tividd/td/ITWSA/ITWSA_info45/en_US/HTML/guide/c-logs.html#combined
    +
    + addr := getAddr(r)
    +
    + username := "-"
    + if user, _, ok := r.BasicAuth(); ok && username != "" {
    + username = user
    + }
    +
    + referer := r.Referer()
    + if referer == "" {
    + referer = "-"
    + }
    +
    + userAgent := r.UserAgent()
    + if userAgent == "" {
    + userAgent = "-"
    + }
    +
    + log.Infof(
    + "%s - %s [%s] \"%s %s %s\" %d %d %q %q\n",
    + addr,
    + username,
    + time.Now().Format("02/Jan/2006:15:04:05 -0700"),
    + r.Method,
    + r.URL.Path,
    + r.Proto,
    + rw.StatusCode(),
    + rw.Written(),
    + referer,
    + userAgent,
    + )
    + }()
    +
    + h.ServeHTTP(rw, r)
    + })
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/http/server.go Mon Mar 07 01:55:50 2022 -0600
    @@ -0,0 +1,75 @@
    +package http
    +
    +import (
    + "net/http"
    + "path/filepath"
    +
    + log "github.com/sirupsen/logrus"
    + "keep.imfreedom.org/grim/hgkeeper/hg"
    + "keep.imfreedom.org/grim/hgkeeper/hgweb"
    +)
    +
    +type Server struct {
    + listenAddr string
    + server *http.Server
    +
    + hgw *hgweb.HGWeb
    +
    + externalHostname string
    + externalPort string
    +}
    +
    +func NewServer(listenAddr string, externalHostname, externalPort string) (*Server, error) {
    + return &Server{
    + listenAddr: listenAddr,
    + server: &http.Server{
    + Addr: listenAddr,
    + },
    + hgw: hgweb.New(),
    + externalHostname: externalHostname,
    + externalPort: externalPort,
    + }, nil
    +}
    +
    +func (s *Server) Listen() error {
    + templatesDir, err := hg.TemplatesDir()
    + if err != nil {
    + return err
    + }
    + staticPath := filepath.Join(templatesDir, "static")
    + log.Infof("serving static files from %s", staticPath)
    + fileServer := http.FileServer(http.Dir(staticPath))
    +
    + mux := http.NewServeMux()
    +
    + if s.externalHostname != "" {
    + mux.Handle("/ssh/authorized_keys", authorizedKeysHandler(s.externalHostname, s.externalPort))
    + log.Infof("added /ssh/authorized_keys endpoint with external hostname %s and export port %s", s.externalHostname, s.externalPort)
    + } else {
    + log.Infof("no external hostname specified, not adding /ssh/authorized_keys endpoint")
    + }
    +
    + mux.Handle("/static/", http.StripPrefix("/static", fileServer))
    +
    + hgwHandler, err := s.hgw.Handler()
    + if err != nil {
    + return err
    + }
    + mux.Handle("/", hgwHandler)
    +
    + s.server.Handler = Logger(mux)
    +
    + log.Infof("http listening on %s", s.listenAddr)
    +
    + return s.server.ListenAndServe()
    +}
    +
    +func (s *Server) Close() {
    + if err := s.hgw.Close(); err != nil {
    + log.Warnf("failed to close hgweb: %v", err)
    + }
    +
    + if err := s.server.Close(); err != nil {
    + log.Warnf("failed to shutdown http server: %v", err)
    + }
    +}
    --- a/serve/command.go Mon Mar 07 01:52:42 2022 -0600
    +++ b/serve/command.go Mon Mar 07 01:55:50 2022 -0600
    @@ -10,7 +10,7 @@
    "keep.imfreedom.org/grim/hgkeeper/access"
    "keep.imfreedom.org/grim/hgkeeper/globals"
    - "keep.imfreedom.org/grim/hgkeeper/hgweb"
    + "keep.imfreedom.org/grim/hgkeeper/http"
    "keep.imfreedom.org/grim/hgkeeper/ssh"
    )
    @@ -40,7 +40,7 @@
    errChan := make(chan error, 10)
    var sshServer *ssh.Server
    - var hgwebServer *hgweb.Server
    + var httpServer *http.Server
    if c.DisableSSH {
    log.Info("SSH server has been disabled")
    @@ -57,11 +57,11 @@
    log.Info("HTTP server has been disabled")
    } else {
    var err error
    - hgwebServer, err = hgweb.NewServer(c.HTTPAddr, c.ExternalHostname, c.ExternalPort)
    + httpServer, err = http.NewServer(c.HTTPAddr, c.ExternalHostname, c.ExternalPort)
    if err != nil {
    return err
    }
    - defer hgwebServer.Close()
    + defer httpServer.Close()
    }
    if !c.DisableSSH {
    @@ -74,7 +74,7 @@
    if !c.DisableHTTP {
    go func() {
    - if err := hgwebServer.Listen(); err != nil {
    + if err := httpServer.Listen(); err != nil {
    errChan <- err
    }
    }()