mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-01 06:50:00 +00:00
5e2bf0bdca
* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
95 lines
3.2 KiB
Go
95 lines
3.2 KiB
Go
// 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 <http://www.gnu.org/licenses/>.
|
|
|
|
package middleware
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/gin-contrib/sessions"
|
|
"github.com/gin-contrib/sessions/memstore"
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
"golang.org/x/net/idna"
|
|
)
|
|
|
|
// SessionOptions returns the standard set of options to use for each session.
|
|
func SessionOptions() sessions.Options {
|
|
var samesite http.SameSite
|
|
switch strings.TrimSpace(strings.ToLower(config.GetAdvancedCookiesSamesite())) {
|
|
case "lax":
|
|
samesite = http.SameSiteLaxMode
|
|
case "strict":
|
|
samesite = http.SameSiteStrictMode
|
|
default:
|
|
log.Warnf(nil, "%s set to %s which is not recognized, defaulting to 'lax'", config.AdvancedCookiesSamesiteFlag(), config.GetAdvancedCookiesSamesite())
|
|
samesite = http.SameSiteLaxMode
|
|
}
|
|
|
|
return sessions.Options{
|
|
Path: "/",
|
|
Domain: config.GetHost(),
|
|
// 2 minutes
|
|
MaxAge: 120,
|
|
// only set secure over https
|
|
Secure: config.GetProtocol() == "https",
|
|
// forbid javascript from inspecting cookie
|
|
HttpOnly: true,
|
|
// https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-cookie-same-site-00#section-4.1.1
|
|
SameSite: samesite,
|
|
}
|
|
}
|
|
|
|
// SessionName is a utility function that derives an appropriate session name from the hostname.
|
|
func SessionName() (string, error) {
|
|
// parse the protocol + host
|
|
protocol := config.GetProtocol()
|
|
host := config.GetHost()
|
|
u, err := url.Parse(fmt.Sprintf("%s://%s", protocol, host))
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
// take the hostname without any port attached
|
|
strippedHostname := u.Hostname()
|
|
if strippedHostname == "" {
|
|
return "", fmt.Errorf("could not derive hostname without port from %s://%s", protocol, host)
|
|
}
|
|
|
|
// make sure IDNs are converted to punycode or the cookie library breaks:
|
|
// see https://en.wikipedia.org/wiki/Punycode
|
|
punyHostname, err := idna.New().ToASCII(strippedHostname)
|
|
if err != nil {
|
|
return "", fmt.Errorf("could not convert %s to punycode: %s", strippedHostname, err)
|
|
}
|
|
|
|
return fmt.Sprintf("gotosocial-%s", punyHostname), nil
|
|
}
|
|
|
|
// Session returns a new gin middleware that implements session cookies using the given
|
|
// sessionName, authentication key, and encryption key. Session name can be derived from the
|
|
// SessionName utility function in this package.
|
|
func Session(sessionName string, auth []byte, crypt []byte) gin.HandlerFunc {
|
|
store := memstore.NewStore(auth, crypt)
|
|
store.Options(SessionOptions())
|
|
return sessions.Sessions(sessionName, store)
|
|
}
|