// GoToSocial // Copyright (C) GoToSocial Authors admin@gotosocial.org // SPDX-License-Identifier: AGPL-3.0-or-later // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package middleware import ( "context" "crypto/rand" "crypto/sha256" "crypto/subtle" "encoding/hex" "hash" "io" "net/http" "time" "codeberg.org/gruf/go-byteutil" "github.com/gin-gonic/gin" apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model" apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util" "github.com/superseriousbusiness/gotosocial/internal/config" "github.com/superseriousbusiness/gotosocial/internal/gtserror" "github.com/superseriousbusiness/gotosocial/internal/oauth" ) func NoLLaMas(getInstanceV1 func(context.Context) (*apimodel.InstanceV1, gtserror.WithCode)) gin.HandlerFunc { if !config.GetAdvancedScraperDeterrence() { // NoLLaMas middleware disabled. return func(*gin.Context) {} } seed := make([]byte, 32) // Read random data for the token seed. _, err := io.ReadFull(rand.Reader, seed) if err != nil { panic(err) } // Configure nollamas. var nollamas nollamas nollamas.seed = seed nollamas.ttl = time.Hour nollamas.diff = 4 nollamas.getInstanceV1 = getInstanceV1 return nollamas.Serve } // i.e. outputted hash slice length. const hashLen = sha256.BlockSize // i.e. hex.EncodedLen(hashLen). const encodedHashLen = 2 * hashLen // hashWithBufs encompasses a hash along // with the necessary buffers to generate // a hashsum and then encode that sum. type hashWithBufs struct { hash hash.Hash hbuf []byte ebuf []byte } type nollamas struct { seed []byte // unique token seed ttl time.Duration diff uint8 getInstanceV1 func(ctx context.Context) (*apimodel.InstanceV1, gtserror.WithCode) } func (m *nollamas) Serve(c *gin.Context) { if c.Request.Method != http.MethodGet { // Only interested in protecting // crawlable 'GET' endpoints. c.Next() return } if _, ok := c.Get(oauth.SessionAuthorizedToken); ok { // Don't guard against requests // providing valid OAuth tokens. c.Next() return } // Prepare hash + buffers. hash := hashWithBufs{ hash: sha256.New(), hbuf: make([]byte, 0, hashLen), ebuf: make([]byte, encodedHashLen), } // Generate a unique token for // this request only valid for // a period of now +- m.ttl. token := m.token(c, &hash) // For unique challenge string just use a // portion of their unique 'success' token. // SHA256 is not yet cracked, this is not an // application of a hash requiring serious // cryptographic security and it rotates on // a TTL basis, so it should be fine. challenge := token[:len(token)/2] // Check for a provided success token. cookie, _ := c.Cookie("gts-nollamas") if len(cookie) > encodedHashLen { // Clearly invalid cookie, just // present them with new challenge. m.renderChallenge(c, challenge) return } // Check whether passed cookie // is the expected success token. if subtle.ConstantTimeCompare( byteutil.S2B(token), byteutil.S2B(cookie), ) == 1 { // They passed us a valid, expected // token. They already passed checks. c.Next() return } // Check query to see if an in-progress // challenge solution has been provided. query := c.Request.URL.Query() nonce := query.Get("nollamas_solution") if nonce == "" || len(nonce) > 20 { // An invalid solution string, just // present them with new challenge. m.renderChallenge(c, challenge) return } // Reset the hash. hash.hash.Reset() // Hash and encode input challenge with // proposed nonce as a possible solution. hash.hash.Write(byteutil.S2B(challenge)) hash.hash.Write(byteutil.S2B(nonce)) hash.hbuf = hash.hash.Sum(hash.hbuf[:0]) hex.Encode(hash.ebuf, hash.hbuf) solution := hash.ebuf // Check that the first 'diff' // many chars are indeed zeroes. for i := range m.diff { if solution[i] != '0' { // They failed challenge, // re-present challenge page. m.renderChallenge(c, challenge) return } } // Drop the solution from query. query.Del("nollamas_solution") c.Request.URL.RawQuery = query.Encode() // They passed the challenge! Set success // token cookie and allow them to continue. c.SetCookie("gts-nollamas", token, int(m.ttl/time.Second), "", "", false, false) c.Next() } func (m *nollamas) renderChallenge(c *gin.Context, challenge string) { // Don't pass to further // handlers, they only get // our challenge page. c.Abort() // Fetch current instance information for templating vars. instance, errWithCode := m.getInstanceV1(c.Request.Context()) if errWithCode != nil { apiutil.ErrorHandler(c, errWithCode, m.getInstanceV1) return } // Write the templated challenge HTML response to client. apiutil.TemplateWebPage(c, apiutil.WebPage{ Template: "nollamas.tmpl", Instance: instance, Extra: map[string]any{ "challenge": challenge, "difficulty": m.diff, }, Javascript: []apiutil.JavascriptEntry{ { Src: "/assets/dist/nollamas.js", Defer: true, }, }, }) } func (m *nollamas) token(c *gin.Context, hash *hashWithBufs) string { // Use our safe, unique input seed which // is already hashed, but will get rehashed. // This ensures we don't leak private keys, // but also we have cryptographically safe // deterministic tokens for comparisons. hash.hash.Write(m.seed) // Include difficulty level in // hash input data so if config // changes then token invalidates. hash.hash.Write([]byte{m.diff}) // Also seed the generated input with // current time rounded to TTL, so our // single comparison handles expiries. now := time.Now().Round(m.ttl).Unix() hash.hash.Write([]byte{ byte(now >> 56), byte(now >> 48), byte(now >> 40), byte(now >> 32), byte(now >> 24), byte(now >> 16), byte(now >> 8), byte(now), }) // Finally, append unique client request data. userAgent := c.Request.Header.Get("User-Agent") hash.hash.Write(byteutil.S2B(userAgent)) clientIP := c.ClientIP() hash.hash.Write(byteutil.S2B(clientIP)) // Return hex encoded hash output. hash.hbuf = hash.hash.Sum(hash.hbuf[:0]) hex.Encode(hash.ebuf, hash.hbuf) return string(hash.ebuf) }