Skip to content

Commit c4ace67

Browse files
Update readme, CI go version, copyright date
1 parent 37abd50 commit c4ace67

File tree

3 files changed

+26
-14
lines changed

3 files changed

+26
-14
lines changed

.github/workflows/continuous-integration-workflow.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
- uses: actions/checkout@v2
1010
- uses: actions/setup-go@v2
1111
with:
12-
go-version: "1.21"
12+
go-version: "1.23"
1313
- name: Run gofmt
1414
run: gofmt -s .
1515
- name: Execute golint
@@ -36,7 +36,7 @@ jobs:
3636
- uses: actions/checkout@v2
3737
- uses: actions/setup-go@v2
3838
with:
39-
go-version: "1.21"
39+
go-version: "1.23"
4040
- name: Test
4141
run: |
4242
go install github.com/go-swagger/go-swagger/cmd/swagger@v0.30.3
@@ -49,7 +49,7 @@ jobs:
4949
build:
5050
strategy:
5151
matrix:
52-
go-version: ["1.20", "1.21"]
52+
go-version: ["1.22", "1.23"]
5353
platform: [ubuntu-latest, macos-latest, windows-latest]
5454
fail-fast: true
5555
runs-on: ${{ matrix.platform }}

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 Contrast Security
3+
Copyright (c) 2025 Contrast Security
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55
[![GoDoc](https://godoc.org/github.com/Contrast-Security-OSS/go-test-bench?status.svg)](https://pkg.go.dev/github.com/Contrast-Security-OSS/go-test-bench)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8-
> Intentionally vulnerable go app. Used Go's standard library, `net/http`,
9-
for client/server implementations. For more info on this framework, visit
10-
[net/http](https://golang.org/pkg/net/http/).
8+
An intentionally vulnerable go app, now available in these refreshing flavors:
9+
* `cmd/std` uses Go's standard library, [`net/http`](https://golang.org/pkg/net/http/).
10+
* `cmd/gin` uses [github.com/gin-gonic/gin](https://github.com/gin-gonic/gin)
11+
* `cmd/chi` uses [github.com/go-chi/chi](https://github.com/go-chi/chi)
12+
* `cmd/go-swagger` uses [github.com/go-openapi](https://github.com/go-openapi).
13+
* `cmd/julienschmidt` uses [github.com/julienschmidt/httprouter](https://github.com/julienschmidt/httprouter)
1114

1215
The go-test-bench application includes vulnerabilities from the OWASP Top
1316
10 and is intended to be used as an educational tool for developers and
14-
security professionals. Any maintainers are welcome to make pull requests.
17+
security professionals. PRs welcome!
1518

1619
> For customer demonstrations [click here to follow the Demo.md readme](./Demo.md).
1720
@@ -23,15 +26,19 @@ security professionals. Any maintainers are welcome to make pull requests.
2326

2427
## How to Run Locally
2528

26-
* standard library
29+
To run with the standard library,
2730
```bash
2831
go build -o app ./cmd/std
2932
./app
3033
```
3134

32-
To run with gin instead, substitute `gin` for `std` in the build command; likewise for `go-swagger` and `julienschmidt`.
35+
To run with gin instead, substitute `gin` for `std` in the build command,
36+
and likewise for `chi`, `go-swagger`, or `julienschmidt`.
3337

34-
View app at [http://localhost:8080](http://localhost:8080)
38+
The app can be viewed in your browser at [http://localhost:8080](http://localhost:8080)
39+
40+
Note that the app loads resources from subdirs, so you _will_ need to run from
41+
the dir this README.md is in.
3542

3643
## How to Run Using Docker
3744

@@ -62,14 +69,19 @@ The development [team](docs/acknowledgements.md).
6269
* exception: vulnerable functions from a particular framework (see below)
6370
* framework-specific code is located under `cmd/` and `pkg/`
6471
* html templates and css are under `views/`
65-
* vulnerability and route data is in go structs,
72+
* vulnerability and route data is in go structs,
6673
located in the relevant package under `internal/`
6774

6875
### quirks
6976

70-
Each framework is different. We've tried to separate framework logic from vulnerability logic so that adding a framework necessitates a minimum of changes to vulnerability logic, and vice versa.
77+
Each framework is different. We've tried to separate framework logic from
78+
vulnerability logic so that adding a framework necessitates a minimum of
79+
changes to vulnerability logic, and vice versa.
7180

7281
#### swagger
73-
Swagger is a bit unique, in that it has a lot of generated code and requires a swagger spec. To maintain a single source of truth, we generate the swagger spec from our route data. We also generate boilerplate tying a route handler to each swagger endpoint.
82+
Swagger is a bit unique, in that it has a lot of generated code and requires a
83+
swagger spec. To maintain a single source of truth, we generate the swagger
84+
spec from our route data. We also generate boilerplate tying a route handler to
85+
each swagger endpoint.
7486

7587
For details, see [cmd/go-swagger/README.md](cmd/go-swagger/README.md)

0 commit comments

Comments
 (0)