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>
51 <title>Links for %s</title>
55 HTMLEnd = " </body>\n</html>\n"
56 HTMLElement = " <a href=\"%s\"%s>%s</a><br/>\n"
57 SHA256Prefix = "sha256="
59 InternalFlag = ".internal"
61 GPGSigAttr = " data-gpg-sig=true"
63 Warranty = `This program is free software: you can redistribute it and/or modify
64 it under the terms of the GNU General Public License as published by
65 the Free Software Foundation, version 3 of the License.
67 This program is distributed in the hope that it will be useful,
68 but WITHOUT ANY WARRANTY; without even the implied warranty of
69 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
70 GNU General Public License for more details.
72 You should have received a copy of the GNU General Public License
73 along with this program. If not, see <http://www.gnu.org/licenses/>.`
77 pkgPyPI = regexp.MustCompile(`^.*<a href="([^"]+)"[^>]*>(.+)</a><br/>.*$`)
78 Version string = "UNKNOWN"
80 root = flag.String("root", "./packages", "Path to packages directory")
81 bind = flag.String("bind", "[::]:8080", "Address to bind to")
82 tlsCert = flag.String("tls-cert", "", "Path to TLS X.509 certificate")
83 tlsKey = flag.String("tls-key", "", "Path to TLS X.509 private key")
84 norefreshURLPath = flag.String("norefresh", "/norefresh/", "Non-refreshing URL path")
85 refreshURLPath = flag.String("refresh", "/simple/", "Auto-refreshing URL path")
86 gpgUpdateURLPath = flag.String("gpgupdate", "/gpgupdate/", "GPG forceful refreshing URL path")
87 pypiURL = flag.String("pypi", "https://pypi.org/simple/", "Upstream PyPI URL")
88 passwdPath = flag.String("passwd", "passwd", "Path to file with authenticators")
89 passwdCheck = flag.Bool("passwd-check", false, "Test the -passwd file for syntax errors and exit")
90 fsck = flag.Bool("fsck", false, "Check integrity of all packages")
91 maxClients = flag.Int("maxclients", 128, "Maximal amount of simultaneous clients")
92 version = flag.Bool("version", false, "Print version information")
93 warranty = flag.Bool("warranty", false, "Print warranty information")
97 normalizationRe *regexp.Regexp = regexp.MustCompilePOSIX("[-_.]+")
100 func mkdirForPkg(w http.ResponseWriter, r *http.Request, dir string) bool {
101 path := filepath.Join(*root, dir)
102 if _, err := os.Stat(path); os.IsNotExist(err) {
103 if err = os.Mkdir(path, os.FileMode(0777)); err != nil {
104 http.Error(w, err.Error(), http.StatusInternalServerError)
107 log.Println(r.RemoteAddr, "mkdir", dir)
113 w http.ResponseWriter,
119 if _, err := os.Stat(filepath.Join(*root, dir, InternalFlag)); err == nil {
122 resp, err := http.Get(*pypiURL + dir + "/")
124 http.Error(w, err.Error(), http.StatusBadGateway)
127 body, err := ioutil.ReadAll(resp.Body)
130 http.Error(w, err.Error(), http.StatusBadGateway)
133 if !mkdirForPkg(w, r, dir) {
136 dirPath := filepath.Join(*root, dir)
137 var submatches []string
143 for _, lineRaw := range bytes.Split(body, []byte("\n")) {
144 submatches = pkgPyPI.FindStringSubmatch(string(lineRaw))
145 if len(submatches) == 0 {
149 filename = submatches[2]
150 if pkgURL, err = url.Parse(uri); err != nil {
151 http.Error(w, err.Error(), http.StatusInternalServerError)
154 if !strings.HasPrefix(pkgURL.Fragment, SHA256Prefix) {
155 log.Println(r.RemoteAddr, "pypi", filename, "no SHA256 digest provided")
156 http.Error(w, "no SHA256 digest provided", http.StatusBadGateway)
159 digest, err = hex.DecodeString(strings.TrimPrefix(pkgURL.Fragment, SHA256Prefix))
161 http.Error(w, err.Error(), http.StatusBadGateway)
165 uri = pkgURL.String()
166 if pkgURL.Host == "" {
167 uri = *pypiURL + strings.TrimPrefix(uri, "/")
169 path = filepath.Join(dirPath, filename)
170 if filename == filenameGet {
172 // Skip heavy remote call, when shutting down
173 http.Error(w, "shutting down", http.StatusInternalServerError)
176 log.Println(r.RemoteAddr, "pypi download", filename)
177 resp, err = http.Get(uri)
179 log.Println(r.RemoteAddr, "pypi download error:", err.Error())
180 http.Error(w, err.Error(), http.StatusBadGateway)
183 defer resp.Body.Close()
184 hasher := sha256.New()
185 dst, err := TempFile(dirPath)
187 http.Error(w, err.Error(), http.StatusInternalServerError)
190 wr := io.MultiWriter(hasher, dst)
191 if _, err = io.Copy(wr, resp.Body); err != nil {
192 os.Remove(dst.Name())
194 http.Error(w, err.Error(), http.StatusInternalServerError)
197 if bytes.Compare(hasher.Sum(nil), digest) != 0 {
198 log.Println(r.RemoteAddr, "pypi", filename, "digest mismatch")
199 os.Remove(dst.Name())
201 http.Error(w, "digest mismatch", http.StatusBadGateway)
204 if err = dst.Sync(); err != nil {
205 os.Remove(dst.Name())
207 http.Error(w, err.Error(), http.StatusInternalServerError)
211 if err = os.Rename(dst.Name(), path); err != nil {
212 http.Error(w, err.Error(), http.StatusInternalServerError)
215 if err = DirSync(dirPath); err != nil {
216 http.Error(w, err.Error(), http.StatusInternalServerError)
220 if filename == filenameGet || gpgUpdate {
221 if _, err = os.Stat(path); err != nil {
224 resp, err := http.Get(uri + GPGSigExt)
228 if resp.StatusCode != http.StatusOK {
232 sig, err := ioutil.ReadAll(resp.Body)
237 if err = WriteFileSync(dirPath, path+GPGSigExt, sig); err != nil {
238 http.Error(w, err.Error(), http.StatusInternalServerError)
241 log.Println(r.RemoteAddr, "pypi downloaded signature", filename)
244 path = path + SHA256Ext
245 _, err = os.Stat(path)
249 if !os.IsNotExist(err) {
250 http.Error(w, err.Error(), http.StatusInternalServerError)
253 log.Println(r.RemoteAddr, "pypi touch", filename)
254 if err = WriteFileSync(dirPath, path, digest); err != nil {
255 http.Error(w, err.Error(), http.StatusInternalServerError)
262 func listRoot(w http.ResponseWriter, r *http.Request) {
263 files, err := ioutil.ReadDir(*root)
265 http.Error(w, err.Error(), http.StatusInternalServerError)
268 var result bytes.Buffer
269 result.WriteString(fmt.Sprintf(HTMLBegin, "root"))
270 for _, file := range files {
271 if file.Mode().IsDir() {
272 result.WriteString(fmt.Sprintf(
274 *refreshURLPath+file.Name()+"/",
279 result.WriteString(HTMLEnd)
280 w.Write(result.Bytes())
284 w http.ResponseWriter,
290 dirPath := filepath.Join(*root, dir)
292 if !refreshDir(w, r, dir, "", gpgUpdate) {
295 } else if _, err := os.Stat(dirPath); os.IsNotExist(err) && !refreshDir(w, r, dir, "", false) {
298 files, err := ioutil.ReadDir(dirPath)
300 http.Error(w, err.Error(), http.StatusInternalServerError)
303 var result bytes.Buffer
304 result.WriteString(fmt.Sprintf(HTMLBegin, dir))
306 var gpgSigAttr string
307 var filenameClean string
308 for _, file := range files {
309 if !strings.HasSuffix(file.Name(), SHA256Ext) {
313 // Skip expensive I/O when shutting down
314 http.Error(w, "shutting down", http.StatusInternalServerError)
317 data, err = ioutil.ReadFile(filepath.Join(dirPath, file.Name()))
319 http.Error(w, err.Error(), http.StatusInternalServerError)
322 filenameClean = strings.TrimSuffix(file.Name(), SHA256Ext)
323 if _, err = os.Stat(filepath.Join(dirPath, filenameClean+GPGSigExt)); os.IsNotExist(err) {
326 gpgSigAttr = GPGSigAttr
328 result.WriteString(fmt.Sprintf(
330 strings.Join([]string{
331 *refreshURLPath, dir, "/",
332 filenameClean, "#", SHA256Prefix, hex.EncodeToString(data),
338 result.WriteString(HTMLEnd)
339 w.Write(result.Bytes())
342 func servePkg(w http.ResponseWriter, r *http.Request, dir, filename string) {
343 log.Println(r.RemoteAddr, "get", filename)
344 path := filepath.Join(*root, dir, filename)
345 if _, err := os.Stat(path); os.IsNotExist(err) {
346 if !refreshDir(w, r, dir, filename, false) {
350 http.ServeFile(w, r, path)
353 func serveUpload(w http.ResponseWriter, r *http.Request) {
355 username, password, ok := r.BasicAuth()
357 log.Println(r.RemoteAddr, "unauthenticated", username)
358 http.Error(w, "unauthenticated", http.StatusUnauthorized)
361 auther, ok := passwords[username]
362 if !ok || !auther.Auth(password) {
363 log.Println(r.RemoteAddr, "unauthenticated", username)
364 http.Error(w, "unauthenticated", http.StatusUnauthorized)
370 if err = r.ParseMultipartForm(1 << 20); err != nil {
371 http.Error(w, err.Error(), http.StatusBadRequest)
374 pkgNames, exists := r.MultipartForm.Value["name"]
375 if !exists || len(pkgNames) != 1 {
376 http.Error(w, "single name is expected in request", http.StatusBadRequest)
379 dir := normalizationRe.ReplaceAllString(pkgNames[0], "-")
380 dirPath := filepath.Join(*root, dir)
381 var digestExpected []byte
382 if digestExpectedHex, exists := r.MultipartForm.Value["sha256_digest"]; exists {
383 digestExpected, err = hex.DecodeString(digestExpectedHex[0])
385 http.Error(w, "bad sha256_digest: "+err.Error(), http.StatusBadRequest)
389 gpgSigsExpected := make(map[string]struct{})
391 // Checking is it internal package
392 if _, err = os.Stat(filepath.Join(dirPath, InternalFlag)); err != nil {
393 log.Println(r.RemoteAddr, "non-internal package", dir)
394 http.Error(w, "unknown internal package", http.StatusUnauthorized)
398 for _, file := range r.MultipartForm.File["content"] {
399 filename := file.Filename
400 gpgSigsExpected[filename+GPGSigExt] = struct{}{}
401 log.Println(r.RemoteAddr, "put", filename, "by", username)
402 path := filepath.Join(dirPath, filename)
403 if _, err = os.Stat(path); err == nil {
404 log.Println(r.RemoteAddr, "already exists", filename)
405 http.Error(w, "already exists", http.StatusBadRequest)
408 if !mkdirForPkg(w, r, dir) {
411 src, err := file.Open()
414 http.Error(w, err.Error(), http.StatusInternalServerError)
417 dst, err := TempFile(dirPath)
419 http.Error(w, err.Error(), http.StatusInternalServerError)
422 hasher := sha256.New()
423 wr := io.MultiWriter(hasher, dst)
424 if _, err = io.Copy(wr, src); err != nil {
425 os.Remove(dst.Name())
427 http.Error(w, err.Error(), http.StatusInternalServerError)
430 if err = dst.Sync(); err != nil {
431 os.Remove(dst.Name())
433 http.Error(w, err.Error(), http.StatusInternalServerError)
437 digest := hasher.Sum(nil)
438 if digestExpected != nil {
439 if bytes.Compare(digestExpected, digest) == 0 {
440 log.Println(r.RemoteAddr, filename, "good checksum received")
442 log.Println(r.RemoteAddr, filename, "bad checksum received")
443 http.Error(w, "bad checksum", http.StatusBadRequest)
444 os.Remove(dst.Name())
448 if err = os.Rename(dst.Name(), path); err != nil {
449 http.Error(w, err.Error(), http.StatusInternalServerError)
452 if err = DirSync(dirPath); err != nil {
453 http.Error(w, err.Error(), http.StatusInternalServerError)
456 if err = WriteFileSync(dirPath, path+SHA256Ext, digest); err != nil {
457 http.Error(w, err.Error(), http.StatusInternalServerError)
461 for _, file := range r.MultipartForm.File["gpg_signature"] {
462 filename := file.Filename
463 if _, exists := gpgSigsExpected[filename]; !exists {
464 http.Error(w, "unexpected GPG signature filename", http.StatusBadRequest)
467 delete(gpgSigsExpected, filename)
468 log.Println(r.RemoteAddr, "put", filename, "by", username)
469 path := filepath.Join(dirPath, filename)
470 if _, err = os.Stat(path); err == nil {
471 log.Println(r.RemoteAddr, "already exists", filename)
472 http.Error(w, "already exists", http.StatusBadRequest)
475 src, err := file.Open()
477 http.Error(w, err.Error(), http.StatusInternalServerError)
480 sig, err := ioutil.ReadAll(src)
483 http.Error(w, err.Error(), http.StatusInternalServerError)
486 if err = WriteFileSync(dirPath, path, sig); err != nil {
487 http.Error(w, err.Error(), http.StatusInternalServerError)
493 func handler(w http.ResponseWriter, r *http.Request) {
499 if strings.HasPrefix(r.URL.Path, *norefreshURLPath) {
500 path = strings.TrimPrefix(r.URL.Path, *norefreshURLPath)
501 } else if strings.HasPrefix(r.URL.Path, *refreshURLPath) {
502 path = strings.TrimPrefix(r.URL.Path, *refreshURLPath)
504 } else if strings.HasPrefix(r.URL.Path, *gpgUpdateURLPath) {
505 path = strings.TrimPrefix(r.URL.Path, *gpgUpdateURLPath)
509 http.Error(w, "unknown action", http.StatusBadRequest)
512 parts := strings.Split(strings.TrimSuffix(path, "/"), "/")
514 http.Error(w, "invalid path", http.StatusBadRequest)
521 listDir(w, r, parts[0], autorefresh, gpgUpdate)
524 servePkg(w, r, parts[0], parts[1])
529 http.Error(w, "unknown action", http.StatusBadRequest)
533 func goodIntegrity() bool {
534 dirs, err := ioutil.ReadDir(*root)
538 hasher := sha256.New()
539 digest := make([]byte, sha256.Size)
543 for _, dir := range dirs {
544 files, err := ioutil.ReadDir(filepath.Join(*root, dir.Name()))
548 for _, file := range files {
549 if !strings.HasSuffix(file.Name(), SHA256Ext) {
552 pkgName = strings.TrimSuffix(file.Name(), SHA256Ext)
553 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), pkgName))
555 if os.IsNotExist(err) {
561 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), file.Name()))
565 if bytes.Compare(hasher.Sum(digest[:0]), data) == 0 {
566 fmt.Println(pkgName, "GOOD")
569 fmt.Println(pkgName, "BAD")
580 fmt.Println(Warranty)
584 fmt.Println("GoCheese version " + Version + " built with " + runtime.Version())
588 if !goodIntegrity() {
597 if (*tlsCert != "" && *tlsKey == "") || (*tlsCert == "" && *tlsKey != "") {
598 log.Fatalln("Both -tls-cert and -tls-key are required")
601 log.Println("root:", *root, "bind:", *bind)
603 ln, err := net.Listen("tcp", *bind)
607 ln = netutil.LimitListener(ln, *maxClients)
608 server := &http.Server{
609 ReadTimeout: time.Minute,
610 WriteTimeout: time.Minute,
612 http.HandleFunc(*norefreshURLPath, handler)
613 http.HandleFunc(*refreshURLPath, handler)
614 http.HandleFunc(*gpgUpdateURLPath, handler)
616 needsRefreshPasswd := make(chan os.Signal, 0)
617 needsShutdown := make(chan os.Signal, 0)
618 exitErr := make(chan error, 0)
619 signal.Notify(needsRefreshPasswd, syscall.SIGHUP)
620 signal.Notify(needsShutdown, syscall.SIGTERM, syscall.SIGINT)
622 for range needsRefreshPasswd {
623 log.Println("Refreshing passwords")
627 go func(s *http.Server) {
630 log.Println("Shutting down")
631 ctx, cancel := context.WithTimeout(context.TODO(), time.Minute)
632 exitErr <- s.Shutdown(ctx)
637 err = server.Serve(ln)
639 err = server.ServeTLS(ln, *tlsCert, *tlsKey)
641 if err != http.ErrServerClosed {
644 if err := <-exitErr; err != nil {