Compare commits

..

67 commits

Author SHA1 Message Date
Ada
a119f831a3
WIP
All checks were successful
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/release Pipeline was successful
ci/woodpecker/pr/lint Pipeline was successful
2024-05-01 18:33:27 +02:00
Ada
4185614460
WIP 2024-05-01 18:33:27 +02:00
Ada
5730de37c5
WIP 2024-05-01 18:33:27 +02:00
Ada
33edc1f8f7
WIP 2024-05-01 18:33:27 +02:00
Ada
50a97f000e
WIP 2024-05-01 18:33:27 +02:00
Ada
bd6ce41160
WIP 2024-05-01 18:33:27 +02:00
Ada
efb39ecc08
WIP 2024-05-01 18:33:26 +02:00
Ada
2f3bf7dc8d
WIP 2024-05-01 18:33:26 +02:00
Ada
d2038ba564
WIP1 2024-05-01 18:33:26 +02:00
Ada
7a2c8dcf26
WIP 2024-05-01 18:33:26 +02:00
Ada
7b494905ee
WIP 2024-05-01 18:33:26 +02:00
Ada
dec95cb8be
WIP 2024-05-01 18:33:26 +02:00
Ada
bbac53c2d7
WIP 2024-05-01 18:33:26 +02:00
Ada
b13687c96d
📦 Make packaging 2024-05-01 18:33:26 +02:00
Ada
c553565f2c Merge pull request ' Linter to CI' (#17) from ada/ci/lint into main
All checks were successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
Reviewed-on: #17
Reviewed-by: Hacki <hacki@noreply.localhost>
2024-04-10 18:13:41 +00:00
Ada
359caeab0f
💄 pass linter
Some checks failed
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/release Pipeline was successful
ci/woodpecker/pull_request_closed/release Pipeline was successful
ci/woodpecker/pull_request_closed/build Pipeline was successful
ci/woodpecker/pull_request_closed/lint Pipeline was successful
ci/woodpecker/pr/lint Pipeline failed
2024-04-10 20:13:09 +02:00
Ada
c6039e4ee4
Linter on CI 2024-04-10 20:13:05 +02:00
Ada
a9c14cd74c Merge pull request '⬆️ Update dependancies' (#39) from ada/bump-deps into main
All checks were successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
Reviewed-on: #39
2024-04-10 17:46:29 +00:00
Ada
5f63e0af64
⬆️ Update dependancies
All checks were successful
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/release Pipeline was successful
ci/woodpecker/pull_request_closed/release Pipeline was successful
ci/woodpecker/pull_request_closed/build Pipeline was successful
2024-04-10 19:41:33 +02:00
Ada
b7be167dd7 Merge pull request 'Update module golang.org/x/crypto to v0.22.0' (#38) from renovate/golang.org-x-crypto-0.x into main
All checks were successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
Reviewed-on: #38
2024-04-05 19:08:28 +00:00
63cc04e3b6 Update module golang.org/x/crypto to v0.22.0
All checks were successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/pr/release Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pull_request_closed/release Pipeline was successful
ci/woodpecker/pull_request_closed/build Pipeline was successful
2024-04-05 19:00:31 +00:00
Ada
c02bce9841 Merge pull request 'Configure Renovate' (#37) from renovate/configure into main
Some checks failed
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline failed
Reviewed-on: #37
2024-04-05 18:59:37 +00:00
f30ac50718 Add renovate.json
All checks were successful
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/pr/release Pipeline was successful
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pull_request_closed/release Pipeline was successful
ci/woodpecker/pull_request_closed/build Pipeline was successful
2024-04-05 18:58:42 +00:00
Ada
05cd9e3abe Merge pull request '⬆️ bump x/crypto and x/sys dependancies' (#34) from ada/bump-deps into main
All checks were successful
ci/woodpecker/push/release Pipeline was successful
ci/woodpecker/push/build Pipeline was successful
Reviewed-on: #34
2024-03-05 18:39:15 +00:00
Ada
5a26dde806 ⬆️ bump x/crypto and x/sys dependancies 2024-03-05 19:35:19 +01:00
Ada
a5349d587b Merge pull request '🔒 Add secret token hashing with argon2id' (#31) from ada/hash-token into main
Reviewed-on: #31
2024-02-26 21:36:25 +00:00
Ada
93374ac6aa lock: Add secret token hashing with argon2id 2024-02-26 21:46:19 +01:00
Ada
8696fc4d1c Merge pull request ' Implement basic POST request for curl' (#30) from ada/curl-upload into main
Reviewed-on: #30
2024-02-24 23:36:14 +00:00
Ada
9a2ffd9898 Merge pull request '🧪 Add test to ParseExpiration when a value is to high' (#33) from ada/more-utils-test into main
Reviewed-on: #33
2024-02-24 23:35:36 +00:00
Ada
05888973d9 🧪 Add test to ParseExpiration when a value is to high 2024-02-25 00:35:11 +01:00
Ada
93958de6a5 Merge pull request '⬆️ bump go-redis 9.5.1' (#32) from ada/bump-redis into main
Reviewed-on: #32
2024-02-24 23:33:38 +00:00
Ada
9bf69d2757 ⬆️ bump go-redis 9.5.1 2024-02-25 00:32:26 +01:00
Ada
8a88613f89 Implement basic POST request for curl
/ can now read body and create paste, for curl like client, web create with full settings is move to /create
2024-02-24 01:35:26 +01:00
Ada
849a4ff44e Merge pull request 'Add redis connection test before start' (#29) from ada/redis-ping into main
Reviewed-on: #29
2024-02-22 11:55:34 +00:00
Ada
bc57218bc8 Add redis connection test before start 2024-02-21 14:34:19 +01:00
Ada
5c8928d8c9 Merge pull request ' Support filename' (#27) from ada/backend/filename into main
Reviewed-on: #27
2024-02-21 12:56:35 +00:00
Ada
095a676dea Support filename 2024-02-21 13:51:08 +01:00
Ada
bd9b6996b8 Merge pull request '♻️ Use math/rand/v2' (#28) from ada/use-rand-v2 into main
Reviewed-on: #28
2024-02-21 12:28:39 +00:00
Ada
6bf757a733 Merge pull request '👷 Add build releases file on tag' (#26) from ada/release into main
Reviewed-on: #26
2024-02-21 12:27:20 +00:00
Ada
24e8d76460 ♻️ Use math/rand/v2 2024-02-19 00:32:27 +01:00
Ada
7d2aa18df9 👷 Add build releases file on tag 2024-02-18 22:31:19 +01:00
Ada
2545b7550d Merge pull request '⬆️ bump go-redis 9.5.0' (#25) from ada/bump-redis into main
Reviewed-on: #25
2024-02-18 20:51:55 +00:00
Ada
2c712cf793 ⬆️ bump go-redis 9.5.0 2024-02-18 20:32:07 +01:00
Ada
bef9118149 Merge pull request '👷 Docker support' (#19) from ada/docker into main
Reviewed-on: #19
2024-02-18 19:19:29 +00:00
Ada
9c8130c6df 👷 Add docker support and CI related stuff 2024-02-18 19:05:18 +01:00
Ada
36f27f72aa 🔧 Supresss automatic .env load
Automatic load of .env is a problem for Docker and not really usefull in other context
2024-02-18 18:55:57 +01:00
Ada
54faeeda8a Merge pull request '🏗️ Embed static files in binary' (#22) from ada/embed into main
Reviewed-on: #22
2024-02-18 17:53:13 +00:00
Ada
477d8ee34c Merge pull request '♻️ Simplifies return condition' (#23) from ada/simplifies-return into main
Reviewed-on: #23
2024-02-18 00:15:17 +00:00
Ada
c188b73a7f Merge pull request '🐛 fix 404 on first hit' (#21) from ada/fix-404 into main
Reviewed-on: #21
2024-02-18 00:14:13 +00:00
Ada
317f57519d ♻️ Simplifies return condition 2024-02-17 00:32:55 +01:00
Ada
48071ac77a 🏗️ Embed static files in binary 2024-02-17 00:23:32 +01:00
Ada
234d88edd6 🐛 fix 404 on first hit
On first hit, Server() calls for the first time router(). As a result / and /static are only configured after first hit
2024-02-16 22:41:29 +01:00
Ada
c00f777935 Merge pull request '♻️ Move code from main to module' (#18) from ada/refactor into main
Reviewed-on: #18
2024-02-11 23:40:12 +00:00
Ada
8d1295bd23 ♻️ Move code from main to module & clean code 2024-02-12 00:37:51 +01:00
Ada
b225c24900 Merge pull request '💄 Move DELETE logic to specific function' (#16) from ada/backend/refactor-delete into main
Reviewed-on: #16
2024-01-23 21:28:50 +00:00
Ada
66d49d36a3 💄 Move DELETE logic to specific function 2024-01-23 22:28:19 +01:00
Ada
29ec2f78ac Merge pull request 'bump(go-redis): v9.4.0' (#15) from ada/backend/update-redis into main
Reviewed-on: #15
2024-01-23 21:14:52 +00:00
Ada
df8a04d57e bump(go-redis): v9.4.0 2024-01-23 22:13:21 +01:00
Ada
3c9d90566f Merge pull request ' Plak expiration support' (#14) from ada/backend/expiration into main
Reviewed-on: #14
2024-01-23 21:02:45 +00:00
Ada
8ca8bc893e Plak expiration support 2024-01-23 22:00:06 +01:00
Ada
a1ffff4e5b Merge pull request 'fix(backend): broken utf8 on raw view' (#13) from fix/raw/utf-8 into main
Reviewed-on: #13
2023-11-26 19:10:56 +00:00
Ada
a23fe965cc fix(backend): broken utf8 on raw view 2023-11-26 02:53:24 +01:00
Akinimaginable
c285e117fe Merge pull request 'features' (#12) from features into main
Reviewed-on: #12
2023-11-25 23:10:29 +00:00
hacki
9adcb52174 Remove IDE specific files 2023-11-26 00:08:47 +01:00
hacki
eff4c30018 Added line counter + some return optimization 2023-11-26 00:00:53 +01:00
Akinimaginable
36e878c2ac Merge pull request 'clean(backend): make one global redis client' (#10) from clean-db into main
Reviewed-on: #10
2023-11-25 18:18:28 +00:00
Akinimaginable
46d13fcd3a Merge pull request 'clean(backend): Remove duplicate config example' (#9) from clean-env into main
Reviewed-on: #9
2023-11-25 18:16:16 +00:00
18 changed files with 237 additions and 116 deletions

25
.golangci.yaml Normal file
View file

@ -0,0 +1,25 @@
linters:
enable-all: true
disable:
# Deprecated
- varcheck
- ifshort
- interfacer
- maligned
- deadcode
- scopelint
- golint
- structcheck
- exhaustivestruct
- nosnakecase
# Too extremist/unusable
- depguard
- varnamelen
- exhaustruct
- wsl
- contextcheck
- wrapcheck
linters-settings:
lll:
# Too short byt default
line-length: 160

View file

@ -6,7 +6,11 @@
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
version: 1
gitea_urls:
api: https://git.gnous.eu/api/v1
download: https://git.gnous.eu
# set to true if you use a self-signed certificate
skip_tls_verify: false
before:
hooks:
@ -36,10 +40,6 @@ archives:
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
# use zip for windows archives
format_overrides:
- goos: windows
format: zip
nfpms:
-

View file

@ -11,22 +11,7 @@ steps:
from_secret: docker_username
password:
from_secret: docker_password
debug: true
when:
branch: ${CI_REPO_DEFAULT_BRANCH}
event: push
- name: publish_image_tag
image: woodpeckerci/plugin-docker-buildx
settings:
repo: git.gnous.eu/${CI_REPO_OWNER}/plakken
dockerfile: docker/Dockerfile
platforms: linux/amd64,linux/arm64/v8,linux/arm
registry: https://git.gnous.eu
tags:
- ${CI_COMMIT_TAG##v} # Remove v from tag
- stable
username:
from_secret: docker_username
password:
from_secret: docker_password
when:
event: tag

11
.woodpecker/lint.yml Normal file
View file

@ -0,0 +1,11 @@
steps:
lint:
image: golang:1.22
commands:
- go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
- golangci-lint run
when:
- event: pull_request
repo: gnouseu/plakken
- event: push
branch: main

View file

@ -1,8 +1,25 @@
steps:
- name: release
image: goreleaser/goreleaser
- name: Release
image: golang:1.22
commands:
- go install github.com/goreleaser/goreleaser@latest
- goreleaser release
secrets: [ release_token ]
secrets: [ gitea_token ]
when:
event: tag
- name: publish_image_tag
image: woodpeckerci/plugin-docker-buildx
settings:
repo: git.gnous.eu/${CI_REPO_OWNER}/plakken
dockerfile: docker/Dockerfile
platforms: linux/amd64,linux/arm64/v8,linux/arm
registry: https://git.gnous.eu
tags:
- ${CI_COMMIT_TAG##v} # Remove v from tag
- stable
username:
from_secret: docker_username
password:
from_secret: docker_password
when:
event: tag

6
go.mod
View file

@ -4,11 +4,11 @@ go 1.22
require (
github.com/redis/go-redis/v9 v9.5.1
golang.org/x/crypto v0.21.0
golang.org/x/crypto v0.22.0
)
require (
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/sys v0.19.0 // indirect
)

12
go.sum
View file

@ -2,13 +2,13 @@ github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c=
github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0=
github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
github.com/redis/go-redis/v9 v9.5.1 h1:H1X4D3yHPaYrkL5X06Wh6xNVM/pX0Ft4RV0vMGvLBh8=
github.com/redis/go-redis/v9 v9.5.1/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30=
golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

View file

@ -4,19 +4,21 @@ import (
"log"
"os"
"strconv"
"git.gnous.eu/gnouseu/plakken/internal/constant"
)
// InitConfig Structure for program initialisation
// InitConfig Structure for program initialisation.
type InitConfig struct {
ListenAddress string
RedisAddress string
RedisUser string
RedisPassword string
RedisDB int
UrlLength uint8
URLLength uint8
}
// GetConfig Initialise configuration form .env
// GetConfig Initialise configuration form .env.
func GetConfig() InitConfig {
listenAddress := os.Getenv("PLAKKEN_LISTEN")
redisAddress := os.Getenv("PLAKKEN_REDIS_ADDRESS")
@ -37,7 +39,7 @@ func GetConfig() InitConfig {
log.Fatal("Invalid PLAKKEN_URL_LENGTH")
}
if urlLength > 255 {
if urlLength > constant.MaxURLLength {
log.Fatal("PLAKKEN_URL_LENGTH cannot be greater than 255")
}
@ -47,6 +49,6 @@ func GetConfig() InitConfig {
RedisUser: os.Getenv("PLAKKEN_REDIS_USER"),
RedisPassword: os.Getenv("PLAKKEN_REDIS_PASSWORD"),
RedisDB: redisDB,
UrlLength: uint8(urlLength),
URLLength: uint8(urlLength),
}
}

View file

@ -11,4 +11,8 @@ const (
ArgonThreads = 4
ArgonKeyLength = 32
ArgonIterations = 2
MaxURLLength = 255
SecondsInDay = 86400
SecondsInHour = 3600
SecondsInMinute = 60
)

View file

@ -13,9 +13,9 @@ type DBConfig struct {
DB *redis.Client
}
var ctx = context.Background()
var ctx = context.Background() //nolint:gochecknoglobals
// InitDB initialise redis connection settings
// InitDB initialise redis connection settings.
func InitDB(addr string, user string, password string, db int) *redis.Options {
DBConfig := &redis.Options{
Addr: addr,
@ -27,18 +27,20 @@ func InitDB(addr string, user string, password string, db int) *redis.Options {
return DBConfig
}
// ConnectDB make new database connection
// ConnectDB make new database connection.
func ConnectDB(dbConfig *redis.Options) *redis.Client {
localDb := redis.NewClient(dbConfig)
return localDb
localDB := redis.NewClient(dbConfig)
return localDB
}
// Ping test connection to Redis database
// Ping test connection to Redis database.
func Ping(db *redis.Client) error {
status := db.Ping(ctx)
if status.String() != "ping: PONG" {
return &pingError{}
}
return nil
}
@ -65,7 +67,7 @@ func (config DBConfig) InsertPaste(key string, content string, secret string, tt
}
}
func (config DBConfig) UrlExist(url string) bool {
func (config DBConfig) URLExist(url string) bool {
return config.DB.Exists(ctx, url).Val() == 1
}

View file

@ -1,4 +1,4 @@
package httpServer
package httpserver
import (
"embed"
@ -12,7 +12,7 @@ import (
type ServerConfig struct {
HTTPServer *http.Server
UrlLength uint8
URLLength uint8
DB *redis.Client
Static embed.FS
Templates embed.FS
@ -29,11 +29,11 @@ func (config ServerConfig) home(w http.ResponseWriter, _ *http.Request) {
}
}
// Configure HTTP router
// Configure HTTP router.
func (config ServerConfig) router() {
WebConfig := plak.WebConfig{
DB: config.DB,
UrlLength: config.UrlLength,
URLLength: config.URLLength,
Templates: config.Templates,
}
staticFiles := http.FS(config.Static)
@ -46,7 +46,7 @@ func (config ServerConfig) router() {
http.HandleFunc("DELETE /{key}", WebConfig.DeleteRequest)
}
// Config Configure HTTP server
// Config Configure HTTP server.
func Config(listenAddress string) *http.Server {
server := &http.Server{
Addr: listenAddress,
@ -57,7 +57,7 @@ func Config(listenAddress string) *http.Server {
return server
}
// Server Start HTTP server
// Server Start HTTP server.
func (config ServerConfig) Server() {
log.Println("Listening on " + config.HTTPServer.Addr)

View file

@ -5,6 +5,7 @@ import (
"bytes"
"crypto/rand"
"encoding/base64"
"encoding/hex"
"fmt"
"strconv"
"strings"
@ -18,7 +19,7 @@ type argon2idHash struct {
hash []byte
}
// Argon2id config
// Argon2id config.
type config struct {
saltLength uint8
memory uint32
@ -27,7 +28,7 @@ type config struct {
iterations uint32
}
// generateSecret for password hashing or token generation
// generateSecret for password hashing or token generation.
func generateSecret(length uint8) ([]byte, error) {
secret := make([]byte, length)
@ -39,26 +40,26 @@ func generateSecret(length uint8) ([]byte, error) {
return secret, err
}
// GenerateToken generate hexadecimal token
// GenerateToken generate hexadecimal token.
func GenerateToken() (string, error) {
secret, err := generateSecret(constant.TokenLength)
if err != nil {
return "", err
}
token := fmt.Sprintf("%x", secret)
token := hex.EncodeToString(secret)
return token, nil
}
// generateArgon2ID Generate an argon2id hash from source string and specified salt
// generateArgon2ID Generate an argon2id hash from source string and specified salt.
func (config config) generateArgon2ID(source string, salt []byte) []byte {
hash := argon2.IDKey([]byte(source), salt, config.iterations, config.memory, config.threads, config.keyLength)
return hash
}
// Password hash a source string with argon2id, return properly encoded hash
// Password hash a source string with argon2id, return properly encoded hash.
func Password(password string) (string, error) {
config := config{
saltLength: constant.ArgonSaltSize,
@ -95,10 +96,10 @@ func VerifyPassword(password string, hash string) (bool, error) {
return bytes.Equal(result, argon2Hash.hash), nil
}
// parseHash parse existing encoded argon2id string
// parseHash parse existing encoded argon2id string.
func parseHash(source string) (argon2idHash, config, error) {
separateItem := strings.Split(source, "$")
if len(separateItem) != 6 {
if len(separateItem) != 6 { //nolint:gomnd
return argon2idHash{}, config{}, &parseError{message: "Hash format is not valid"}
}
@ -107,7 +108,7 @@ func parseHash(source string) (argon2idHash, config, error) {
}
separateParam := strings.Split(separateItem[3], ",")
if len(separateParam) != 3 {
if len(separateParam) != 3 { //nolint:gomnd
return argon2idHash{}, config{}, &parseError{message: "Hash config is not valid"}
}
@ -126,22 +127,35 @@ func parseHash(source string) (argon2idHash, config, error) {
keyLength := uint32(len(hash))
var memory int
memory, err = strconv.Atoi(strings.Replace(separateParam[0], "m=", "", -1))
memory, err = strconv.Atoi(strings.ReplaceAll(separateParam[0], "m=", ""))
if err != nil {
return argon2idHash{}, config{}, err
}
var iterations int
iterations, err = strconv.Atoi(strings.Replace(separateParam[1], "t=", "", -1))
iterations, err = strconv.Atoi(strings.ReplaceAll(separateParam[1], "t=", ""))
if err != nil {
return argon2idHash{}, config{}, err
}
var threads int
threads, err = strconv.Atoi(strings.Replace(separateParam[2], "p=", "", -1))
threads, err = strconv.Atoi(strings.ReplaceAll(separateParam[2], "p=", ""))
if err != nil {
return argon2idHash{}, config{}, err
}
return argon2idHash{salt: salt, hash: hash}, config{saltLength: saltLength, memory: uint32(memory), threads: uint8(threads), iterations: uint32(iterations), keyLength: keyLength}, nil
argon2idStruct := argon2idHash{
salt: salt,
hash: hash,
}
hashConfig := config{
saltLength: saltLength,
memory: uint32(memory),
threads: uint8(threads),
iterations: uint32(iterations),
keyLength: keyLength,
}
return argon2idStruct, hashConfig, nil
}

View file

@ -6,10 +6,12 @@ import (
"regexp"
"strconv"
"strings"
"git.gnous.eu/gnouseu/plakken/internal/constant"
)
// GenerateUrl generate random string for plak url
func GenerateUrl(length uint8) string {
// GenerateURL generate random string for plak url.
func GenerateURL(length uint8) string {
listChars := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
b := make([]rune, length)
for i := range b {
@ -19,7 +21,7 @@ func GenerateUrl(length uint8) string {
return string(b)
}
// CheckCharRedundant verify is a character is redundant in a string
// CheckCharRedundant verify is a character is redundant in a string.
func CheckCharRedundant(source string, char string) bool { // Verify if a char is redundant
return strings.Count(source, char) > 1
}
@ -34,22 +36,24 @@ func parseIntBeforeSeparator(source *string, sep string) (int, error) { // retur
value, err = strconv.Atoi(strings.Split(*source, sep)[0])
if err != nil {
log.Println(err)
return 0, &parseIntBeforeSeparatorError{message: *source + ": cannot parse value as int"}
}
if value < 0 { // Only positive value is correct
return 0, &parseIntBeforeSeparatorError{message: *source + ": format only take positive value"}
}
if value > 99 {
if value > 99 { //nolint:gomnd
return 0, &parseIntBeforeSeparatorError{message: *source + ": Format only take two number"}
}
*source = strings.Join(strings.Split(*source, sep)[1:], "")
}
return value, nil
}
// ParseExpiration Parse "1d1h1m1s" duration format. Return 0 & error if error
// ParseExpiration Parse "1d1h1m1s" duration format. Return 0 & error if error.
func ParseExpiration(source string) (int, error) {
var expiration int
var tempOutput int
@ -61,39 +65,44 @@ func ParseExpiration(source string) (int, error) {
source = strings.ToLower(source)
tempOutput, err = parseIntBeforeSeparator(&source, "d")
expiration = tempOutput * 86400
expiration = tempOutput * constant.SecondsInDay
if err != nil {
log.Println(err)
return 0, &ParseExpirationError{message: "Invalid syntax"}
}
tempOutput, err = parseIntBeforeSeparator(&source, "h")
expiration += tempOutput * 3600
expiration += tempOutput * constant.SecondsInHour
if err != nil {
log.Println(err)
return 0, &ParseExpirationError{message: "Invalid syntax"}
}
tempOutput, err = parseIntBeforeSeparator(&source, "m")
expiration += tempOutput * 60
expiration += tempOutput * constant.SecondsInMinute
if err != nil {
log.Println(err)
return 0, &ParseExpirationError{message: "Invalid syntax"}
}
tempOutput, err = parseIntBeforeSeparator(&source, "s")
expiration += tempOutput * 1
if err != nil {
log.Println(err)
return 0, &ParseExpirationError{message: "Invalid syntax"}
}
return expiration, nil
}
// ValidKey Verify if a key is valid (only letter, number, - and _)
// ValidKey Verify if a key is valid (only letter, number, - and _).
func ValidKey(key string) bool {
result, err := regexp.MatchString("^[a-zA-Z0-9_.-]*$", key)
if err != nil {
return false
}
log.Println(key, result)
return result
}

View file

@ -3,6 +3,7 @@ package plak
import (
"context"
"embed"
"html/template"
"io"
"log"
"net/http"
@ -13,19 +14,17 @@ import (
"git.gnous.eu/gnouseu/plakken/internal/secret"
"git.gnous.eu/gnouseu/plakken/internal/utils"
"github.com/redis/go-redis/v9"
"html/template"
)
var ctx = context.Background()
var ctx = context.Background() //nolint:gochecknoglobals
type WebConfig struct {
DB *redis.Client
UrlLength uint8
URLLength uint8
Templates embed.FS
}
// plak "Object" for plak
// plak "Object" for plak.
type plak struct {
Key string
Content string
@ -33,7 +32,7 @@ type plak struct {
DB *redis.Client
}
// create a plak
// create a plak.
func (plak plak) create() (string, error) {
dbConf := database.DBConfig{
DB: plak.DB,
@ -44,7 +43,7 @@ func (plak plak) create() (string, error) {
return "", err
}
if dbConf.UrlExist(plak.Key) {
if dbConf.URLExist(plak.Key) {
return "", &createError{message: "key already exist"}
}
@ -59,21 +58,23 @@ func (plak plak) create() (string, error) {
return token, nil
}
// PostCreate manage POST request for create plak
// PostCreate manage POST request for create plak.
func (config WebConfig) PostCreate(w http.ResponseWriter, r *http.Request) {
content := r.FormValue("content")
if content == "" {
w.WriteHeader(http.StatusBadRequest)
return
}
filename := r.FormValue("filename")
var key string
if len(filename) == 0 {
key = utils.GenerateUrl(config.UrlLength)
key = utils.GenerateURL(config.URLLength)
} else {
if !utils.ValidKey(filename) {
w.WriteHeader(http.StatusBadRequest)
return
}
key = filename
@ -90,6 +91,7 @@ func (config WebConfig) PostCreate(w http.ResponseWriter, r *http.Request) {
if err != nil {
log.Println(err)
w.WriteHeader(http.StatusInternalServerError)
return
}
@ -103,16 +105,18 @@ func (config WebConfig) PostCreate(w http.ResponseWriter, r *http.Request) {
if err != nil {
log.Println(err)
w.WriteHeader(http.StatusInternalServerError)
return
}
http.Redirect(w, r, "/"+key, http.StatusSeeOther)
}
// CurlCreate PostCreate plak with minimum param, ideal for curl. Force 7 day expiration
// CurlCreate PostCreate plak with minimum param, ideal for curl. Force 7 day expiration.
func (config WebConfig) CurlCreate(w http.ResponseWriter, r *http.Request) {
if r.ContentLength == 0 {
w.WriteHeader(http.StatusBadRequest)
return
}
@ -122,7 +126,7 @@ func (config WebConfig) CurlCreate(w http.ResponseWriter, r *http.Request) {
log.Println(err)
}
key := utils.GenerateUrl(config.UrlLength)
key := utils.GenerateURL(config.URLLength)
plak := plak{
Key: key,
@ -135,6 +139,7 @@ func (config WebConfig) CurlCreate(w http.ResponseWriter, r *http.Request) {
token, err = plak.create()
if err != nil {
w.WriteHeader(http.StatusBadRequest)
return
}
@ -154,7 +159,7 @@ func (config WebConfig) CurlCreate(w http.ResponseWriter, r *http.Request) {
}
}
// View for plak
// View for plak.
func (config WebConfig) View(w http.ResponseWriter, r *http.Request) {
dbConf := database.DBConfig{
DB: config.DB,
@ -162,7 +167,8 @@ func (config WebConfig) View(w http.ResponseWriter, r *http.Request) {
var currentPlak plak
key := r.PathValue("key")
if dbConf.UrlExist(key) {
//nolint:nestif
if dbConf.URLExist(key) {
currentPlak = plak{
Key: key,
DB: config.DB,
@ -179,12 +185,14 @@ func (config WebConfig) View(w http.ResponseWriter, r *http.Request) {
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
log.Println(err)
return
}
err = t.Execute(w, currentPlak)
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
log.Println(err)
return
}
}
@ -193,7 +201,7 @@ func (config WebConfig) View(w http.ResponseWriter, r *http.Request) {
}
}
// DeleteRequest manage plak deletion endpoint
// DeleteRequest manage plak deletion endpoint.
func (config WebConfig) DeleteRequest(w http.ResponseWriter, r *http.Request) {
dbConf := database.DBConfig{
DB: config.DB,
@ -201,7 +209,8 @@ func (config WebConfig) DeleteRequest(w http.ResponseWriter, r *http.Request) {
key := r.PathValue("key")
var valid bool
if dbConf.UrlExist(key) {
//nolint:nestif
if dbConf.URLExist(key) {
var err error
token := r.URL.Query().Get("secret")
@ -209,7 +218,6 @@ func (config WebConfig) DeleteRequest(w http.ResponseWriter, r *http.Request) {
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
log.Println(err)
return
}
if valid {
@ -223,29 +231,31 @@ func (config WebConfig) DeleteRequest(w http.ResponseWriter, r *http.Request) {
}
w.WriteHeader(http.StatusNoContent)
return
} else {
w.WriteHeader(http.StatusForbidden)
return
}
return
}
w.WriteHeader(http.StatusNotFound)
}
// delete DeleteRequest plak from database
// delete DeleteRequest plak from database.
func (plak plak) delete() error {
err := plak.DB.Del(ctx, plak.Key).Err()
if err != nil {
log.Println(err)
return &deletePlakError{name: plak.Key, err: err}
}
return nil
}
// getContent get plak content
// getContent get plak content.
func (plak plak) getContent() plak {
plak.Content = plak.DB.HGet(ctx, plak.Key, "content").Val()
return plak
}

View file

@ -6,7 +6,7 @@ import (
"git.gnous.eu/gnouseu/plakken/internal/config"
"git.gnous.eu/gnouseu/plakken/internal/database"
"git.gnous.eu/gnouseu/plakken/internal/httpServer"
"git.gnous.eu/gnouseu/plakken/internal/httpserver"
)
var (
@ -25,9 +25,9 @@ func main() {
log.Fatal(err)
}
serverConfig := httpServer.ServerConfig{
HTTPServer: httpServer.Config(initConfig.ListenAddress),
UrlLength: initConfig.UrlLength,
serverConfig := httpserver.ServerConfig{
HTTPServer: httpserver.Config(initConfig.ListenAddress),
URLLength: initConfig.URLLength,
DB: db,
Static: static,
Templates: templates,

3
renovate.json Normal file
View file

@ -0,0 +1,3 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json"
}

View file

@ -10,8 +10,17 @@ import (
"golang.org/x/crypto/argon2"
)
func TestPasswordFormat(t *testing.T) {
regex := fmt.Sprintf("\\$argon2id\\$v=%d\\$m=%d,t=%d,p=%d\\$[A-Za-z0-9+/]*\\$[A-Za-z0-9+/]*$", argon2.Version, constant.ArgonMemory, constant.ArgonIterations, constant.ArgonThreads)
func TestSecret(t *testing.T) {
t.Parallel()
testPasswordFormat(t)
testVerifyPassword(t)
testVerifyPasswordInvalid(t)
}
func testPasswordFormat(t *testing.T) {
t.Helper()
regex := fmt.Sprintf("\\$argon2id\\$v=%d\\$m=%d,t=%d,p=%d\\$[A-Za-z0-9+/]*\\$[A-Za-z0-9+/]*$", argon2.Version, constant.ArgonMemory, constant.ArgonIterations, constant.ArgonThreads) //nolint:lll
got, err := secret.Password("Password!")
if err != nil {
@ -24,8 +33,9 @@ func TestPasswordFormat(t *testing.T) {
}
}
func TestVerifyPassword(t *testing.T) {
result, err := secret.VerifyPassword("Password!", "$argon2id$v=19$m=65536,t=2,p=4$A+t5YGpyy1BHCbvk/LP1xQ$eNuUj6B2ZqXlGi6KEqep39a7N4nysUIojuPXye+Ypp0")
func testVerifyPassword(t *testing.T) {
t.Helper()
result, err := secret.VerifyPassword("Password!", "$argon2id$v=19$m=65536,t=2,p=4$A+t5YGpyy1BHCbvk/LP1xQ$eNuUj6B2ZqXlGi6KEqep39a7N4nysUIojuPXye+Ypp0") //nolint:lll
if err != nil {
t.Fatal(err)
}
@ -35,8 +45,9 @@ func TestVerifyPassword(t *testing.T) {
}
}
func TestVerifyPasswordInvalid(t *testing.T) {
result, err := secret.VerifyPassword("notsamepassword", "$argon2id$v=19$m=65536,t=2,p=4$A+t5YGpyy1BHCbvk/LP1xQ$eNuUj6B2ZqXlGi6KEqep39a7N4nysUIojuPXye+Ypp0")
func testVerifyPasswordInvalid(t *testing.T) {
t.Helper()
result, err := secret.VerifyPassword("notsamepassword", "$argon2id$v=19$m=65536,t=2,p=4$A+t5YGpyy1BHCbvk/LP1xQ$eNuUj6B2ZqXlGi6KEqep39a7N4nysUIojuPXye+Ypp0") //nolint:lll
if err != nil {
t.Fatal(err)
}

View file

@ -7,7 +7,25 @@ import (
"git.gnous.eu/gnouseu/plakken/internal/utils"
)
func TestCheckCharNotRedundantTrue(t *testing.T) { // Test CheckCharRedundant with redundant char
func TestUtils(t *testing.T) {
t.Parallel()
testCheckCharNotRedundantTrue(t)
testCheckCharNotRedundantFalse(t)
testParseExpirationFull(t)
testParseExpirationMissing(t)
testParseExpirationWithCaps(t)
testParseExpirationNull(t)
testParseExpirationNegative(t)
testParseExpirationInvalid(t)
testParseExpirationInvalidRedundant(t)
testParseExpirationInvalidTooHigh(t)
testValidKey(t)
testInValidKey(t)
}
func testCheckCharNotRedundantTrue(t *testing.T) { // Test CheckCharRedundant with redundant char
t.Helper()
want := true
got := utils.CheckCharRedundant("2d1h3md4h7s", "h")
if got != want {
@ -15,7 +33,8 @@ func TestCheckCharNotRedundantTrue(t *testing.T) { // Test CheckCharRedundant wi
}
}
func TestCheckCharNotRedundantFalse(t *testing.T) { // Test CheckCharRedundant with not redundant char
func testCheckCharNotRedundantFalse(t *testing.T) { // Test CheckCharRedundant with not redundant char
t.Helper()
want := false
got := utils.CheckCharRedundant("2d1h3m47s", "h")
if got != want {
@ -23,7 +42,8 @@ func TestCheckCharNotRedundantFalse(t *testing.T) { // Test CheckCharRedundant w
}
}
func TestParseExpirationFull(t *testing.T) { // test parseExpirationFull with all valid separator
func testParseExpirationFull(t *testing.T) { // test parseExpirationFull with all valid separator
t.Helper()
result, _ := utils.ParseExpiration("2d1h3m47s")
correctValue := 176627
if result != correctValue {
@ -31,7 +51,8 @@ func TestParseExpirationFull(t *testing.T) { // test parseExpirationFull with al
}
}
func TestParseExpirationMissing(t *testing.T) { // test parseExpirationFull with all valid separator
func testParseExpirationMissing(t *testing.T) { // test parseExpirationFull with all valid separator
t.Helper()
result, _ := utils.ParseExpiration("1h47s")
correctValue := 3647
if result != correctValue {
@ -39,7 +60,8 @@ func TestParseExpirationMissing(t *testing.T) { // test parseExpirationFull with
}
}
func TestParseExpirationWithCaps(t *testing.T) { // test parseExpirationFull with all valid separator
func testParseExpirationWithCaps(t *testing.T) { // test parseExpirationFull with all valid separator
t.Helper()
result, _ := utils.ParseExpiration("2D1h3M47s")
correctValue := 176627
if result != correctValue {
@ -47,7 +69,8 @@ func TestParseExpirationWithCaps(t *testing.T) { // test parseExpirationFull wit
}
}
func TestParseExpirationNull(t *testing.T) { // test ParseExpirationFull with all valid separator
func testParseExpirationNull(t *testing.T) { // test ParseExpirationFull with all valid separator
t.Helper()
result, _ := utils.ParseExpiration("0")
correctValue := 0
if result != correctValue {
@ -55,7 +78,8 @@ func TestParseExpirationNull(t *testing.T) { // test ParseExpirationFull with al
}
}
func TestParseExpirationNegative(t *testing.T) { // test ParseExpirationFull with all valid separator
func testParseExpirationNegative(t *testing.T) { // test ParseExpirationFull with all valid separator
t.Helper()
_, got := utils.ParseExpiration("-42h1m4s")
want := &utils.ParseExpirationError{}
if !errors.As(got, &want) {
@ -63,16 +87,17 @@ func TestParseExpirationNegative(t *testing.T) { // test ParseExpirationFull wit
}
}
func TestParseExpirationInvalid(t *testing.T) { // test ParseExpirationFull with all valid separator
func testParseExpirationInvalid(t *testing.T) { // test ParseExpirationFull with all valid separator
t.Helper()
_, got := utils.ParseExpiration("8h42h1m1d4s")
want := &utils.ParseExpirationError{}
if !errors.As(got, &want) {
t.Fatal("Error in ParseExpirationFull, want : ", want, "got : ", got)
}
}
func TestParseExpirationInvalidRedundant(t *testing.T) { // test ParseExpirationFull with all valid separator
func testParseExpirationInvalidRedundant(t *testing.T) { // test ParseExpirationFull with all valid separator
t.Helper()
_, got := utils.ParseExpiration("8h42h1m1h4s")
want := &utils.ParseExpirationError{}
if !errors.As(got, &want) {
@ -80,7 +105,8 @@ func TestParseExpirationInvalidRedundant(t *testing.T) { // test ParseExpiration
}
}
func TestParseExpirationInvalidTooHigh(t *testing.T) { // test ParseExpirationFull with all valid separator
func testParseExpirationInvalidTooHigh(t *testing.T) { // test ParseExpirationFull with all valid separator
t.Helper()
_, got := utils.ParseExpiration("2d1h3m130s")
want := &utils.ParseExpirationError{}
if !errors.As(got, &want) {
@ -88,7 +114,8 @@ func TestParseExpirationInvalidTooHigh(t *testing.T) { // test ParseExpirationFu
}
}
func TestValidKey(t *testing.T) { // test ValidKey with a valid key
func testValidKey(t *testing.T) { // test ValidKey with a valid key
t.Helper()
got := utils.ValidKey("ab_a-C42")
want := true
@ -97,7 +124,8 @@ func TestValidKey(t *testing.T) { // test ValidKey with a valid key
}
}
func TestInValidKey(t *testing.T) { // test ValidKey with invalid key
func testInValidKey(t *testing.T) { // test ValidKey with invalid key
t.Helper()
got := utils.ValidKey("ab_?a-C42")
want := false