2 GoCheese -- Python private package repository and caching proxy
3 Copyright (C) 2019 Sergey Matveev <stargrave@stargrave.org>
4 2019 Elena Balakhonova <balakhonova_e@riseup.net>
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, version 3 of the License.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 // Python private package repository and caching proxy
44 "golang.org/x/net/netutil"
48 HTMLBegin = "<!DOCTYPE html><html><head><title>Links for %s</title></head><body><h1>Links for %s</h1>\n"
49 HTMLEnd = "</body></html>"
50 HTMLElement = "<a href='%s'>%s</a><br/>\n"
51 SHA256Prefix = "sha256="
53 InternalFlag = ".internal"
55 Warranty = `This program is free software: you can redistribute it and/or modify
56 it under the terms of the GNU General Public License as published by
57 the Free Software Foundation, version 3 of the License.
59 This program is distributed in the hope that it will be useful,
60 but WITHOUT ANY WARRANTY; without even the implied warranty of
61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
62 GNU General Public License for more details.
64 You should have received a copy of the GNU General Public License
65 along with this program. If not, see <http://www.gnu.org/licenses/>.`
69 pkgPyPI = regexp.MustCompile(`^.*<a href="([^"]+)"[^>]*>(.+)</a><br/>.*$`)
70 Version string = "UNKNOWN"
72 root = flag.String("root", "./packages", "Path to packages directory")
73 bind = flag.String("bind", "[::]:8080", "Address to bind to")
74 tlsCert = flag.String("tls-cert", "", "Path to TLS X.509 certificate")
75 tlsKey = flag.String("tls-key", "", "Path to TLS X.509 private key")
76 norefreshURLPath = flag.String("norefresh", "/norefresh/", "Non-refreshing URL path")
77 refreshURLPath = flag.String("refresh", "/simple/", "Auto-refreshing URL path")
78 pypiURL = flag.String("pypi", "https://pypi.org/simple/", "Upstream PyPI URL")
79 passwdPath = flag.String("passwd", "passwd", "Path to file with authenticators")
80 passwdCheck = flag.Bool("passwd-check", false, "Test the -passwd file for syntax errors and exit")
81 fsck = flag.Bool("fsck", false, "Check integrity of all packages")
82 maxClients = flag.Int("maxclients", 128, "Maximal amount of simultaneous clients")
83 version = flag.Bool("version", false, "Print version information")
84 warranty = flag.Bool("warranty", false, "Print warranty information")
87 func mkdirForPkg(w http.ResponseWriter, r *http.Request, dir string) bool {
88 path := filepath.Join(*root, dir)
89 if _, err := os.Stat(path); os.IsNotExist(err) {
90 if err = os.Mkdir(path, os.FileMode(0777)); err != nil {
91 http.Error(w, err.Error(), http.StatusInternalServerError)
94 log.Println(r.RemoteAddr, "mkdir", dir)
99 func refreshDir(w http.ResponseWriter, r *http.Request, dir, filenameGet string) bool {
100 if _, err := os.Stat(filepath.Join(*root, dir, InternalFlag)); err == nil {
101 log.Println(r.RemoteAddr, "pypi refresh skip, internal package", dir)
104 log.Println(r.RemoteAddr, "pypi refresh", dir)
105 resp, err := http.Get(*pypiURL + dir + "/")
107 http.Error(w, err.Error(), http.StatusBadGateway)
110 body, err := ioutil.ReadAll(resp.Body)
113 http.Error(w, err.Error(), http.StatusBadGateway)
116 if !mkdirForPkg(w, r, dir) {
119 var submatches []string
125 for _, lineRaw := range bytes.Split(body, []byte("\n")) {
126 submatches = pkgPyPI.FindStringSubmatch(string(lineRaw))
127 if len(submatches) == 0 {
131 filename = submatches[2]
132 if pkgURL, err = url.Parse(uri); err != nil {
133 http.Error(w, err.Error(), http.StatusInternalServerError)
136 digest, err = hex.DecodeString(strings.TrimPrefix(pkgURL.Fragment, SHA256Prefix))
138 http.Error(w, err.Error(), http.StatusBadGateway)
141 if filename == filenameGet {
142 log.Println(r.RemoteAddr, "pypi download", filename)
143 path = filepath.Join(*root, dir, filename)
144 resp, err = http.Get(uri)
146 http.Error(w, err.Error(), http.StatusBadGateway)
149 defer resp.Body.Close()
150 hasher := sha256.New()
151 dst, err := TempFile(filepath.Join(*root, dir))
153 http.Error(w, err.Error(), http.StatusInternalServerError)
156 wr := io.MultiWriter(hasher, dst)
157 if _, err = io.Copy(wr, resp.Body); err != nil {
158 os.Remove(dst.Name())
160 http.Error(w, err.Error(), http.StatusInternalServerError)
163 if bytes.Compare(hasher.Sum(nil), digest) != 0 {
164 log.Println(r.RemoteAddr, "pypi", filename, "digest mismatch")
165 os.Remove(dst.Name())
167 http.Error(w, err.Error(), http.StatusBadGateway)
170 if err = dst.Sync(); err != nil {
171 os.Remove(dst.Name())
173 http.Error(w, err.Error(), http.StatusInternalServerError)
177 if err = os.Rename(dst.Name(), path); err != nil {
178 http.Error(w, err.Error(), http.StatusInternalServerError)
182 path = filepath.Join(*root, dir, filename+SHA256Ext)
183 _, err = os.Stat(path)
187 if !os.IsNotExist(err) {
188 http.Error(w, err.Error(), http.StatusInternalServerError)
191 log.Println(r.RemoteAddr, "pypi touch", filename)
192 if err = ioutil.WriteFile(path, digest, os.FileMode(0666)); err != nil {
193 http.Error(w, err.Error(), http.StatusInternalServerError)
200 func listRoot(w http.ResponseWriter, r *http.Request) {
201 log.Println(r.RemoteAddr, "root")
202 files, err := ioutil.ReadDir(*root)
204 http.Error(w, err.Error(), http.StatusInternalServerError)
207 var result bytes.Buffer
208 result.WriteString(fmt.Sprintf(HTMLBegin, "root", "root"))
209 for _, file := range files {
210 if file.Mode().IsDir() {
211 result.WriteString(fmt.Sprintf(
213 *refreshURLPath+file.Name()+"/",
218 result.WriteString(HTMLEnd)
219 w.Write(result.Bytes())
222 func listDir(w http.ResponseWriter, r *http.Request, dir string, autorefresh bool) {
223 log.Println(r.RemoteAddr, "dir", dir)
224 dirPath := filepath.Join(*root, dir)
226 if !refreshDir(w, r, dir, "") {
229 } else if _, err := os.Stat(dirPath); os.IsNotExist(err) && !refreshDir(w, r, dir, "") {
232 files, err := ioutil.ReadDir(dirPath)
234 http.Error(w, err.Error(), http.StatusInternalServerError)
237 var result bytes.Buffer
238 result.WriteString(fmt.Sprintf(HTMLBegin, dir, dir))
240 var filenameClean string
241 for _, file := range files {
242 if !strings.HasSuffix(file.Name(), SHA256Ext) {
245 data, err = ioutil.ReadFile(filepath.Join(dirPath, file.Name()))
247 http.Error(w, err.Error(), http.StatusInternalServerError)
250 filenameClean = strings.TrimSuffix(file.Name(), SHA256Ext)
251 result.WriteString(fmt.Sprintf(
253 strings.Join([]string{
254 *refreshURLPath, dir, "/",
255 filenameClean, "#", SHA256Prefix, hex.EncodeToString(data),
260 result.WriteString(HTMLEnd)
261 w.Write(result.Bytes())
264 func servePkg(w http.ResponseWriter, r *http.Request, dir, filename string) {
265 log.Println(r.RemoteAddr, "pkg", filename)
266 path := filepath.Join(*root, dir, filename)
267 if _, err := os.Stat(path); os.IsNotExist(err) {
268 if !refreshDir(w, r, dir, filename) {
272 http.ServeFile(w, r, path)
275 func serveUpload(w http.ResponseWriter, r *http.Request) {
276 username, password, ok := r.BasicAuth()
278 log.Println(r.RemoteAddr, "unauthenticated", username)
279 http.Error(w, "unauthenticated", http.StatusUnauthorized)
282 auther, ok := passwords[username]
283 if !ok || !auther.Auth(password) {
284 log.Println(r.RemoteAddr, "unauthenticated", username)
285 http.Error(w, "unauthenticated", http.StatusUnauthorized)
289 if err = r.ParseMultipartForm(1 << 20); err != nil {
290 http.Error(w, err.Error(), http.StatusBadRequest)
293 for _, file := range r.MultipartForm.File["content"] {
294 filename := file.Filename
295 log.Println(r.RemoteAddr, "upload", filename, "by", username)
296 dir := filename[:strings.LastIndex(filename, "-")]
297 dirPath := filepath.Join(*root, dir)
298 path := filepath.Join(dirPath, filename)
299 if _, err = os.Stat(path); err == nil {
300 log.Println(r.RemoteAddr, "already exists", filename)
301 http.Error(w, "Already exists", http.StatusBadRequest)
304 if !mkdirForPkg(w, r, dir) {
307 internalPath := filepath.Join(dirPath, InternalFlag)
309 if _, err = os.Stat(internalPath); os.IsNotExist(err) {
310 if dst, err = os.Create(internalPath); err != nil {
311 http.Error(w, err.Error(), http.StatusInternalServerError)
316 src, err := file.Open()
319 http.Error(w, err.Error(), http.StatusInternalServerError)
322 dst, err = TempFile(dirPath)
324 http.Error(w, err.Error(), http.StatusInternalServerError)
327 hasher := sha256.New()
328 wr := io.MultiWriter(hasher, dst)
329 if _, err = io.Copy(wr, src); err != nil {
330 os.Remove(dst.Name())
332 http.Error(w, err.Error(), http.StatusInternalServerError)
335 if err = dst.Sync(); err != nil {
336 os.Remove(dst.Name())
338 http.Error(w, err.Error(), http.StatusInternalServerError)
342 if err = os.Rename(dst.Name(), path); err != nil {
343 http.Error(w, err.Error(), http.StatusInternalServerError)
346 if err = ioutil.WriteFile(path+SHA256Ext, hasher.Sum(nil), os.FileMode(0666)); err != nil {
347 http.Error(w, err.Error(), http.StatusInternalServerError)
353 func handler(w http.ResponseWriter, r *http.Request) {
354 if r.Method == "GET" {
357 if strings.HasPrefix(r.URL.Path, *norefreshURLPath) {
358 path = strings.TrimPrefix(r.URL.Path, *norefreshURLPath)
361 path = strings.TrimPrefix(r.URL.Path, *refreshURLPath)
364 parts := strings.Split(strings.TrimSuffix(path, "/"), "/")
366 http.Error(w, "invalid path", http.StatusBadRequest)
373 listDir(w, r, parts[0], autorefresh)
376 servePkg(w, r, parts[0], parts[1])
378 } else if r.Method == "POST" {
383 func goodIntegrity() bool {
384 dirs, err := ioutil.ReadDir(*root)
388 hasher := sha256.New()
389 digest := make([]byte, sha256.Size)
393 for _, dir := range dirs {
394 files, err := ioutil.ReadDir(filepath.Join(*root, dir.Name()))
398 for _, file := range files {
399 if !strings.HasSuffix(file.Name(), SHA256Ext) {
402 pkgName = strings.TrimSuffix(file.Name(), SHA256Ext)
403 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), pkgName))
405 if os.IsNotExist(err) {
411 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), file.Name()))
415 if bytes.Compare(hasher.Sum(digest[:0]), data) == 0 {
416 log.Println(pkgName, "GOOD")
419 log.Println(pkgName, "BAD")
430 fmt.Println(Warranty)
434 fmt.Println("GoCheese version " + Version + " built with " + runtime.Version())
438 if !goodIntegrity() {
447 if (*tlsCert != "" && *tlsKey == "") || (*tlsCert == "" && *tlsKey != "") {
448 log.Fatalln("Both -tls-cert and -tls-key are required")
451 log.Println("root:", *root, "bind:", *bind)
453 ln, err := net.Listen("tcp", *bind)
457 ln = netutil.LimitListener(ln, *maxClients)
458 server := &http.Server{
459 ReadTimeout: time.Minute,
460 WriteTimeout: time.Minute,
462 http.HandleFunc(*norefreshURLPath, handler)
463 http.HandleFunc(*refreshURLPath, handler)
465 needsRefreshPasswd := make(chan os.Signal, 0)
466 needsShutdown := make(chan os.Signal, 0)
467 killed := make(chan error, 0)
468 signal.Notify(needsRefreshPasswd, syscall.SIGHUP)
469 signal.Notify(needsShutdown, syscall.SIGTERM, syscall.SIGINT)
471 for range needsRefreshPasswd {
472 log.Println("Refreshing passwords")
476 go func(s *http.Server) {
478 log.Println("Shutting down")
479 ctx, cancel := context.WithTimeout(context.TODO(), time.Minute)
480 killed <- s.Shutdown(ctx)
485 err = server.Serve(ln)
487 err = server.ServeTLS(ln, *tlsCert, *tlsKey)
489 if err != http.ErrServerClosed {
492 if err := <-killed; err != nil {