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)
206 if filename == filenameGet || gpgUpdate {
207 if _, err = os.Stat(path); err == nil {
208 if resp, err := http.Get(pkgURL.String() + GPGSigExt); err == nil {
209 sig, err := ioutil.ReadAll(resp.Body)
212 if err = WriteFileSync(dirPath, path+GPGSigExt, sig); err != nil {
213 http.Error(w, err.Error(), http.StatusInternalServerError)
216 log.Println(r.RemoteAddr, "pypi downloaded signature", filename)
221 path = path + SHA256Ext
222 _, err = os.Stat(path)
226 if !os.IsNotExist(err) {
227 http.Error(w, err.Error(), http.StatusInternalServerError)
230 log.Println(r.RemoteAddr, "pypi touch", filename)
231 if err = WriteFileSync(dirPath, path, digest); err != nil {
232 http.Error(w, err.Error(), http.StatusInternalServerError)
239 func listRoot(w http.ResponseWriter, r *http.Request) {
240 files, err := ioutil.ReadDir(*root)
242 http.Error(w, err.Error(), http.StatusInternalServerError)
245 var result bytes.Buffer
246 result.WriteString(fmt.Sprintf(HTMLBegin, "root"))
247 for _, file := range files {
248 if file.Mode().IsDir() {
249 result.WriteString(fmt.Sprintf(
251 *refreshURLPath+file.Name()+"/",
256 result.WriteString(HTMLEnd)
257 w.Write(result.Bytes())
261 w http.ResponseWriter,
267 dirPath := filepath.Join(*root, dir)
269 if !refreshDir(w, r, dir, "", gpgUpdate) {
272 } else if _, err := os.Stat(dirPath); os.IsNotExist(err) && !refreshDir(w, r, dir, "", false) {
275 files, err := ioutil.ReadDir(dirPath)
277 http.Error(w, err.Error(), http.StatusInternalServerError)
280 var result bytes.Buffer
281 result.WriteString(fmt.Sprintf(HTMLBegin, dir))
283 var gpgSigAttr string
284 var filenameClean string
285 for _, file := range files {
286 if !strings.HasSuffix(file.Name(), SHA256Ext) {
290 // Skip expensive I/O when shutting down
291 http.Error(w, "shutting down", http.StatusInternalServerError)
294 data, err = ioutil.ReadFile(filepath.Join(dirPath, file.Name()))
296 http.Error(w, err.Error(), http.StatusInternalServerError)
299 filenameClean = strings.TrimSuffix(file.Name(), SHA256Ext)
300 if _, err = os.Stat(filepath.Join(dirPath, filenameClean+GPGSigExt)); os.IsNotExist(err) {
303 gpgSigAttr = GPGSigAttr
305 result.WriteString(fmt.Sprintf(
307 strings.Join([]string{
308 *refreshURLPath, dir, "/",
309 filenameClean, "#", SHA256Prefix, hex.EncodeToString(data),
315 result.WriteString(HTMLEnd)
316 w.Write(result.Bytes())
319 func servePkg(w http.ResponseWriter, r *http.Request, dir, filename string) {
320 log.Println(r.RemoteAddr, "get", filename)
321 path := filepath.Join(*root, dir, filename)
322 if _, err := os.Stat(path); os.IsNotExist(err) {
323 if !refreshDir(w, r, dir, filename, false) {
327 http.ServeFile(w, r, path)
330 func serveUpload(w http.ResponseWriter, r *http.Request) {
332 username, password, ok := r.BasicAuth()
334 log.Println(r.RemoteAddr, "unauthenticated", username)
335 http.Error(w, "unauthenticated", http.StatusUnauthorized)
338 auther, ok := passwords[username]
339 if !ok || !auther.Auth(password) {
340 log.Println(r.RemoteAddr, "unauthenticated", username)
341 http.Error(w, "unauthenticated", http.StatusUnauthorized)
347 if err = r.ParseMultipartForm(1 << 20); err != nil {
348 http.Error(w, err.Error(), http.StatusBadRequest)
351 pkgNames, exists := r.MultipartForm.Value["name"]
352 if !exists || len(pkgNames) != 1 {
353 http.Error(w, "single name is expected in request", http.StatusBadRequest)
356 dir := normalizationRe.ReplaceAllString(pkgNames[0], "-")
357 dirPath := filepath.Join(*root, dir)
358 var digestExpected []byte
359 if digestExpectedHex, exists := r.MultipartForm.Value["sha256_digest"]; exists {
360 digestExpected, err = hex.DecodeString(digestExpectedHex[0])
362 http.Error(w, "bad sha256_digest: "+err.Error(), http.StatusBadRequest)
366 gpgSigsExpected := make(map[string]struct{})
368 // Checking is it internal package
369 if _, err = os.Stat(filepath.Join(dirPath, InternalFlag)); err != nil {
370 log.Println(r.RemoteAddr, "non-internal package", dir)
371 http.Error(w, "unknown internal package", http.StatusUnauthorized)
375 for _, file := range r.MultipartForm.File["content"] {
376 filename := file.Filename
377 gpgSigsExpected[filename+GPGSigExt] = struct{}{}
378 log.Println(r.RemoteAddr, "put", filename, "by", username)
379 path := filepath.Join(dirPath, filename)
380 if _, err = os.Stat(path); err == nil {
381 log.Println(r.RemoteAddr, "already exists", filename)
382 http.Error(w, "already exists", http.StatusBadRequest)
385 if !mkdirForPkg(w, r, dir) {
388 src, err := file.Open()
391 http.Error(w, err.Error(), http.StatusInternalServerError)
394 dst, err := TempFile(dirPath)
396 http.Error(w, err.Error(), http.StatusInternalServerError)
399 hasher := sha256.New()
400 wr := io.MultiWriter(hasher, dst)
401 if _, err = io.Copy(wr, src); err != nil {
402 os.Remove(dst.Name())
404 http.Error(w, err.Error(), http.StatusInternalServerError)
407 if err = dst.Sync(); err != nil {
408 os.Remove(dst.Name())
410 http.Error(w, err.Error(), http.StatusInternalServerError)
414 digest := hasher.Sum(nil)
415 if digestExpected != nil {
416 if bytes.Compare(digestExpected, digest) == 0 {
417 log.Println(r.RemoteAddr, filename, "good checksum received")
419 log.Println(r.RemoteAddr, filename, "bad checksum received")
420 http.Error(w, "bad checksum", http.StatusBadRequest)
421 os.Remove(dst.Name())
425 if err = os.Rename(dst.Name(), path); err != nil {
426 http.Error(w, err.Error(), http.StatusInternalServerError)
429 if err = WriteFileSync(dirPath, path+SHA256Ext, digest); err != nil {
430 http.Error(w, err.Error(), http.StatusInternalServerError)
434 for _, file := range r.MultipartForm.File["gpg_signature"] {
435 filename := file.Filename
436 if _, exists := gpgSigsExpected[filename]; !exists {
437 http.Error(w, "unexpected GPG signature filename", http.StatusBadRequest)
440 delete(gpgSigsExpected, filename)
441 log.Println(r.RemoteAddr, "put", filename, "by", username)
442 path := filepath.Join(dirPath, filename)
443 if _, err = os.Stat(path); err == nil {
444 log.Println(r.RemoteAddr, "already exists", filename)
445 http.Error(w, "already exists", http.StatusBadRequest)
448 src, err := file.Open()
450 http.Error(w, err.Error(), http.StatusInternalServerError)
453 sig, err := ioutil.ReadAll(src)
456 http.Error(w, err.Error(), http.StatusInternalServerError)
459 if err = WriteFileSync(dirPath, path, sig); err != nil {
460 http.Error(w, err.Error(), http.StatusInternalServerError)
466 func handler(w http.ResponseWriter, r *http.Request) {
472 if strings.HasPrefix(r.URL.Path, *norefreshURLPath) {
473 path = strings.TrimPrefix(r.URL.Path, *norefreshURLPath)
474 } else if strings.HasPrefix(r.URL.Path, *refreshURLPath) {
475 path = strings.TrimPrefix(r.URL.Path, *refreshURLPath)
477 } else if strings.HasPrefix(r.URL.Path, *gpgUpdateURLPath) {
478 path = strings.TrimPrefix(r.URL.Path, *gpgUpdateURLPath)
482 http.Error(w, "unknown action", http.StatusBadRequest)
485 parts := strings.Split(strings.TrimSuffix(path, "/"), "/")
487 http.Error(w, "invalid path", http.StatusBadRequest)
494 listDir(w, r, parts[0], autorefresh, gpgUpdate)
497 servePkg(w, r, parts[0], parts[1])
502 http.Error(w, "unknown action", http.StatusBadRequest)
506 func goodIntegrity() bool {
507 dirs, err := ioutil.ReadDir(*root)
511 hasher := sha256.New()
512 digest := make([]byte, sha256.Size)
516 for _, dir := range dirs {
517 files, err := ioutil.ReadDir(filepath.Join(*root, dir.Name()))
521 for _, file := range files {
522 if !strings.HasSuffix(file.Name(), SHA256Ext) {
525 pkgName = strings.TrimSuffix(file.Name(), SHA256Ext)
526 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), pkgName))
528 if os.IsNotExist(err) {
534 data, err = ioutil.ReadFile(filepath.Join(*root, dir.Name(), file.Name()))
538 if bytes.Compare(hasher.Sum(digest[:0]), data) == 0 {
539 log.Println(pkgName, "GOOD")
542 log.Println(pkgName, "BAD")
553 fmt.Println(Warranty)
557 fmt.Println("GoCheese version " + Version + " built with " + runtime.Version())
561 if !goodIntegrity() {
570 if (*tlsCert != "" && *tlsKey == "") || (*tlsCert == "" && *tlsKey != "") {
571 log.Fatalln("Both -tls-cert and -tls-key are required")
574 log.Println("root:", *root, "bind:", *bind)
576 ln, err := net.Listen("tcp", *bind)
580 ln = netutil.LimitListener(ln, *maxClients)
581 server := &http.Server{
582 ReadTimeout: time.Minute,
583 WriteTimeout: time.Minute,
585 http.HandleFunc(*norefreshURLPath, handler)
586 http.HandleFunc(*refreshURLPath, handler)
587 http.HandleFunc(*gpgUpdateURLPath, handler)
589 needsRefreshPasswd := make(chan os.Signal, 0)
590 needsShutdown := make(chan os.Signal, 0)
591 exitErr := make(chan error, 0)
592 signal.Notify(needsRefreshPasswd, syscall.SIGHUP)
593 signal.Notify(needsShutdown, syscall.SIGTERM, syscall.SIGINT)
595 for range needsRefreshPasswd {
596 log.Println("Refreshing passwords")
600 go func(s *http.Server) {
603 log.Println("Shutting down")
604 ctx, cancel := context.WithTimeout(context.TODO(), time.Minute)
605 exitErr <- s.Shutdown(ctx)
610 err = server.Serve(ln)
612 err = server.ServeTLS(ln, *tlsCert, *tlsKey)
614 if err != http.ErrServerClosed {
617 if err := <-exitErr; err != nil {