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 digest, err = hex.DecodeString(strings.TrimPrefix(pkgURL.Fragment, SHA256Prefix))
156 http.Error(w, err.Error(), http.StatusBadGateway)
160 path = filepath.Join(dirPath, filename)
161 if filename == filenameGet {
163 // Skip heavy remote call, when shutting down
164 http.Error(w, "shutting down", http.StatusInternalServerError)
167 log.Println(r.RemoteAddr, "pypi download", filename)
168 resp, err = http.Get(pkgURL.String())
170 http.Error(w, err.Error(), http.StatusBadGateway)
173 defer resp.Body.Close()
174 hasher := sha256.New()
175 dst, err := TempFile(dirPath)
177 http.Error(w, err.Error(), http.StatusInternalServerError)
180 wr := io.MultiWriter(hasher, dst)
181 if _, err = io.Copy(wr, resp.Body); err != nil {
182 os.Remove(dst.Name())
184 http.Error(w, err.Error(), http.StatusInternalServerError)
187 if bytes.Compare(hasher.Sum(nil), digest) != 0 {
188 log.Println(r.RemoteAddr, "pypi", filename, "digest mismatch")
189 os.Remove(dst.Name())
191 http.Error(w, err.Error(), http.StatusBadGateway)
194 if err = dst.Sync(); err != nil {
195 os.Remove(dst.Name())
197 http.Error(w, err.Error(), http.StatusInternalServerError)
201 if err = os.Rename(dst.Name(), path); err != nil {
202 http.Error(w, err.Error(), http.StatusInternalServerError)
205 if err = DirSync(dirPath); err != nil {
206 http.Error(w, err.Error(), http.StatusInternalServerError)
210 if filename == filenameGet || gpgUpdate {
211 if _, err = os.Stat(path); err != nil {
214 resp, err := http.Get(pkgURL.String() + GPGSigExt)
218 if resp.StatusCode != http.StatusOK {
222 sig, err := ioutil.ReadAll(resp.Body)
227 if err = WriteFileSync(dirPath, path+GPGSigExt, sig); err != nil {
228 http.Error(w, err.Error(), http.StatusInternalServerError)
231 log.Println(r.RemoteAddr, "pypi downloaded signature", filename)
234 path = path + SHA256Ext
235 _, err = os.Stat(path)
239 if !os.IsNotExist(err) {
240 http.Error(w, err.Error(), http.StatusInternalServerError)
243 log.Println(r.RemoteAddr, "pypi touch", filename)
244 if err = WriteFileSync(dirPath, path, digest); err != nil {
245 http.Error(w, err.Error(), http.StatusInternalServerError)
252 func listRoot(w http.ResponseWriter, r *http.Request) {
253 files, err := ioutil.ReadDir(*root)
255 http.Error(w, err.Error(), http.StatusInternalServerError)
258 var result bytes.Buffer
259 result.WriteString(fmt.Sprintf(HTMLBegin, "root"))
260 for _, file := range files {
261 if file.Mode().IsDir() {
262 result.WriteString(fmt.Sprintf(
264 *refreshURLPath+file.Name()+"/",
269 result.WriteString(HTMLEnd)
270 w.Write(result.Bytes())
274 w http.ResponseWriter,
280 dirPath := filepath.Join(*root, dir)
282 if !refreshDir(w, r, dir, "", gpgUpdate) {
285 } else if _, err := os.Stat(dirPath); os.IsNotExist(err) && !refreshDir(w, r, dir, "", false) {
288 files, err := ioutil.ReadDir(dirPath)
290 http.Error(w, err.Error(), http.StatusInternalServerError)
293 var result bytes.Buffer
294 result.WriteString(fmt.Sprintf(HTMLBegin, dir))
296 var gpgSigAttr string
297 var filenameClean string
298 for _, file := range files {
299 if !strings.HasSuffix(file.Name(), SHA256Ext) {
303 // Skip expensive I/O when shutting down
304 http.Error(w, "shutting down", http.StatusInternalServerError)
307 data, err = ioutil.ReadFile(filepath.Join(dirPath, file.Name()))
309 http.Error(w, err.Error(), http.StatusInternalServerError)
312 filenameClean = strings.TrimSuffix(file.Name(), SHA256Ext)
313 if _, err = os.Stat(filepath.Join(dirPath, filenameClean+GPGSigExt)); os.IsNotExist(err) {
316 gpgSigAttr = GPGSigAttr
318 result.WriteString(fmt.Sprintf(
320 strings.Join([]string{
321 *refreshURLPath, dir, "/",
322 filenameClean, "#", SHA256Prefix, hex.EncodeToString(data),
328 result.WriteString(HTMLEnd)
329 w.Write(result.Bytes())
332 func servePkg(w http.ResponseWriter, r *http.Request, dir, filename string) {
333 log.Println(r.RemoteAddr, "get", filename)
334 path := filepath.Join(*root, dir, filename)
335 if _, err := os.Stat(path); os.IsNotExist(err) {
336 if !refreshDir(w, r, dir, filename, false) {
340 http.ServeFile(w, r, path)
343 func serveUpload(w http.ResponseWriter, r *http.Request) {
345 username, password, ok := r.BasicAuth()
347 log.Println(r.RemoteAddr, "unauthenticated", username)
348 http.Error(w, "unauthenticated", http.StatusUnauthorized)
351 auther, ok := passwords[username]
352 if !ok || !auther.Auth(password) {
353 log.Println(r.RemoteAddr, "unauthenticated", username)
354 http.Error(w, "unauthenticated", http.StatusUnauthorized)
360 if err = r.ParseMultipartForm(1 << 20); err != nil {
361 http.Error(w, err.Error(), http.StatusBadRequest)
364 pkgNames, exists := r.MultipartForm.Value["name"]
365 if !exists || len(pkgNames) != 1 {
366 http.Error(w, "single name is expected in request", http.StatusBadRequest)
369 dir := normalizationRe.ReplaceAllString(pkgNames[0], "-")
370 dirPath := filepath.Join(*root, dir)
371 var digestExpected []byte
372 if digestExpectedHex, exists := r.MultipartForm.Value["sha256_digest"]; exists {
373 digestExpected, err = hex.DecodeString(digestExpectedHex[0])
375 http.Error(w, "bad sha256_digest: "+err.Error(), http.StatusBadRequest)
379 gpgSigsExpected := make(map[string]struct{})
381 // Checking is it internal package
382 if _, err = os.Stat(filepath.Join(dirPath, InternalFlag)); err != nil {
383 log.Println(r.RemoteAddr, "non-internal package", dir)
384 http.Error(w, "unknown internal package", http.StatusUnauthorized)
388 for _, file := range r.MultipartForm.File["content"] {
389 filename := file.Filename
390 gpgSigsExpected[filename+GPGSigExt] = struct{}{}
391 log.Println(r.RemoteAddr, "put", filename, "by", username)
392 path := filepath.Join(dirPath, filename)
393 if _, err = os.Stat(path); err == nil {
394 log.Println(r.RemoteAddr, "already exists", filename)
395 http.Error(w, "already exists", http.StatusBadRequest)
398 if !mkdirForPkg(w, r, dir) {
401 src, err := file.Open()
404 http.Error(w, err.Error(), http.StatusInternalServerError)
407 dst, err := TempFile(dirPath)
409 http.Error(w, err.Error(), http.StatusInternalServerError)
412 hasher := sha256.New()
413 wr := io.MultiWriter(hasher, dst)
414 if _, err = io.Copy(wr, src); err != nil {
415 os.Remove(dst.Name())
417 http.Error(w, err.Error(), http.StatusInternalServerError)
420 if err = dst.Sync(); err != nil {
421 os.Remove(dst.Name())
423 http.Error(w, err.Error(), http.StatusInternalServerError)
427 digest := hasher.Sum(nil)
428 if digestExpected != nil {
429 if bytes.Compare(digestExpected, digest) == 0 {
430 log.Println(r.RemoteAddr, filename, "good checksum received")
432 log.Println(r.RemoteAddr, filename, "bad checksum received")
433 http.Error(w, "bad checksum", http.StatusBadRequest)
434 os.Remove(dst.Name())
438 if err = os.Rename(dst.Name(), path); err != nil {
439 http.Error(w, err.Error(), http.StatusInternalServerError)
442 if err = DirSync(dirPath); err != nil {
443 http.Error(w, err.Error(), http.StatusInternalServerError)
446 if err = WriteFileSync(dirPath, path+SHA256Ext, digest); err != nil {
447 http.Error(w, err.Error(), http.StatusInternalServerError)
451 for _, file := range r.MultipartForm.File["gpg_signature"] {
452 filename := file.Filename
453 if _, exists := gpgSigsExpected[filename]; !exists {
454 http.Error(w, "unexpected GPG signature filename", http.StatusBadRequest)
457 delete(gpgSigsExpected, filename)
458 log.Println(r.RemoteAddr, "put", filename, "by", username)
459 path := filepath.Join(dirPath, filename)
460 if _, err = os.Stat(path); err == nil {
461 log.Println(r.RemoteAddr, "already exists", filename)
462 http.Error(w, "already exists", http.StatusBadRequest)
465 src, err := file.Open()
467 http.Error(w, err.Error(), http.StatusInternalServerError)
470 sig, err := ioutil.ReadAll(src)
473 http.Error(w, err.Error(), http.StatusInternalServerError)
476 if err = WriteFileSync(dirPath, path, sig); err != nil {
477 http.Error(w, err.Error(), http.StatusInternalServerError)
483 func handler(w http.ResponseWriter, r *http.Request) {
489 if strings.HasPrefix(r.URL.Path, *norefreshURLPath) {
490 path = strings.TrimPrefix(r.URL.Path, *norefreshURLPath)
491 } else if strings.HasPrefix(r.URL.Path, *refreshURLPath) {
492 path = strings.TrimPrefix(r.URL.Path, *refreshURLPath)
494 } else if strings.HasPrefix(r.URL.Path, *gpgUpdateURLPath) {
495 path = strings.TrimPrefix(r.URL.Path, *gpgUpdateURLPath)
499 http.Error(w, "unknown action", http.StatusBadRequest)
502 parts := strings.Split(strings.TrimSuffix(path, "/"), "/")
504 http.Error(w, "invalid path", http.StatusBadRequest)
511 listDir(w, r, parts[0], autorefresh, gpgUpdate)
514 servePkg(w, r, parts[0], parts[1])
519 http.Error(w, "unknown action", http.StatusBadRequest)
523 func goodIntegrity() bool {
524 dirs, err := ioutil.ReadDir(*root)
528 hasher := sha256.New()
529 digest := make([]byte, sha256.Size)
533 for _, dir := range dirs {
534 files, err := ioutil.ReadDir(filepath.Join(*root, dir.Name()))
538 for _, file := range files {
539 if !strings.HasSuffix(file.Name(), SHA256Ext) {
542 pkgName = strings.TrimSuffix(file.Name(), SHA256Ext)
543 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), pkgName))
545 if os.IsNotExist(err) {
551 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), file.Name()))
555 if bytes.Compare(hasher.Sum(digest[:0]), data) == 0 {
556 log.Println(pkgName, "GOOD")
559 log.Println(pkgName, "BAD")
570 fmt.Println(Warranty)
574 fmt.Println("GoCheese version " + Version + " built with " + runtime.Version())
578 if !goodIntegrity() {
587 if (*tlsCert != "" && *tlsKey == "") || (*tlsCert == "" && *tlsKey != "") {
588 log.Fatalln("Both -tls-cert and -tls-key are required")
591 log.Println("root:", *root, "bind:", *bind)
593 ln, err := net.Listen("tcp", *bind)
597 ln = netutil.LimitListener(ln, *maxClients)
598 server := &http.Server{
599 ReadTimeout: time.Minute,
600 WriteTimeout: time.Minute,
602 http.HandleFunc(*norefreshURLPath, handler)
603 http.HandleFunc(*refreshURLPath, handler)
604 http.HandleFunc(*gpgUpdateURLPath, handler)
606 needsRefreshPasswd := make(chan os.Signal, 0)
607 needsShutdown := make(chan os.Signal, 0)
608 exitErr := make(chan error, 0)
609 signal.Notify(needsRefreshPasswd, syscall.SIGHUP)
610 signal.Notify(needsShutdown, syscall.SIGTERM, syscall.SIGINT)
612 for range needsRefreshPasswd {
613 log.Println("Refreshing passwords")
617 go func(s *http.Server) {
620 log.Println("Shutting down")
621 ctx, cancel := context.WithTimeout(context.TODO(), time.Minute)
622 exitErr <- s.Shutdown(ctx)
627 err = server.Serve(ln)
629 err = server.ServeTLS(ln, *tlsCert, *tlsKey)
631 if err != http.ErrServerClosed {
634 if err := <-exitErr; err != nil {