Skip to content

Commit c0dd41f

Browse files
committed
Update version and README
1 parent 0254e60 commit c0dd41f

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ For help type **erised -h**
2525

2626
When executing **erised** with no parameters, the server will listen on port **8080** for incoming http requests.
2727

28-
If you're using the _-path_ option, please **EXERCISE GREAT CAUTION** when setting the path to search. See **Known Issues** for more information.
28+
If you're using the _-path_ option, please **EXERCISE GREAT CAUTION** when setting the path to search. See **Known Issues** for more information. For security reasons, path is restricted to the directory or subdirectories where the program was invoked.
2929

3030
The latest version is also available as a Docker image at [edaddario/erised](https://hub.docker.com/r/edaddario/erised).
3131

3232
To start the server in a docker container, with defaults values, execute the following command:
3333

3434
```sh
35-
docker run --rm -p 8080:8080 --name erised edaddario/erised
35+
docker run --rm -p 8080:8080 --name erised edaddario/erised [flags]
3636
```
3737

3838
If you would like to return file based responses (_X-Erised-Response-File_ set) when using the docker image, you'll need to map the directory containing your local files and set the _-path_ option accordingly.
@@ -104,6 +104,7 @@ NetworkAuthenticationRequired or 511
104104
Any other value will resolve to 200 (OK)
105105

106106
# Release History
107+
* v0.7.0 - Improve response file processing and security, change logging type, and minor source code readability changes
107108
* v0.6.11 - Further server shutdown improvements, minor efficiency improvements, general code refactoring and bug fixes
108109
* v0.6.7 - Improve server shutdown handling, and restrict allowed methods for _erised/headers_, _erised/ip_, _erised/info_ and _erised/shutdown_ routes
109110
* v0.5.4 - Update dependencies
@@ -122,7 +123,7 @@ Any other value will resolve to 200 (OK)
122123
**erised** may be full of bugs. Poeple "_... have wasted away before it, not knowing if what they have seen is real, or even possible..._" so, use it with caution for it gives no knowledge or truth.
123124

124125
Of all of its deficiencies, the most notable is:
125-
* Using the _-path_ option could lead to significant security risks. By default, **erised** sets this option to point to the same directory in which is running and, when the _X-Erised-Response-File_ header is set, it will search recursively for a matching filename in the current directory and **all** subdirectories underneath, returning the contents of the first match. For example, if you set this value to your root directory (_-path=/_) **erised** will scan the entire volume for a match
126+
* Using the _-path_ option could lead to significant security risks. When the _X-Erised-Response-File_ header is set it will search recursively for a matching filename in the current directory or **all** subdirectories underneath, returning the contents of the first match. For security reasons, path is restricted to the directory or subdirectories where the program was invoked.
126127
* https protocol is not yet supported
127128

128129
I may or may not address these issues in a future release. Caveat Emptor

cmd/erised/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"syscall"
1414
)
1515

16-
const version = "v0.6.11"
16+
const version = "v0.7.0"
1717

1818
func main() {
1919
cd, err := os.Getwd()

0 commit comments

Comments
 (0)