Skip to content

Commit 5f964fd

Browse files
committed
Add initial readme
1 parent c5ae1ce commit 5f964fd

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
Attractive html formatting for rendering in github. sorry text editor
3+
readers! Besides the header and section links, everything should be clean and
4+
readable.
5+
-->
6+
<h1 align="center">httpsig</h1>
7+
<p align="center"><i>Standards-based HTTP request signing and verification for<a href="https://golang.org">Go</a></i></p>
8+
9+
<div align="center">
10+
<a href="https://godoc.org/github.com/jbowes/httpsig"><img src="https://godoc.org/github.com/jbowes/httpsig?status.svg" alt="GoDoc"></a>
11+
<img alt="Alpha Quality" src="https://img.shields.io/badge/status-ALPHA-orange.svg" >
12+
<a href="./LICENSE"><img alt="BSD license" src="https://img.shields.io/badge/license-BSD-blue.svg"></a>
13+
<a href="https://goreportcard.com/report/github.com/jbowes/httpsig"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/jbowes/httpsig"></a>
14+
</div><br /><br />
15+
16+
## Introduction
17+
18+
`httpsig` provides support for signing and verifying HTTP requests according
19+
to the [Signing HTTP Messages][msgsig] draft standard. This standard focuses
20+
on signing headers and request paths, and you probably want to sign the
21+
request body too, so body digest calculation according to
22+
[Digest Headers][dighdr] is included.
23+
24+
## The Big Feature Matrix
25+
26+
This implementation is based on version `05` of "Signing HTTP Messages"
27+
(`draft-ietf-htttpbis-message-signatures-05`). Digest computation is based on
28+
version `05` of "Digest Headers" (`draft-ietf-httpbis-digest-headers-05`).
29+
30+
## Contributing
31+
32+
I would love your help!
33+
34+
`httpsig` is still a work in progress. You can help by:
35+
36+
- Opening a pull request to resolve an [open issue][issues].
37+
- Adding a feature or enhancement of your own! If it might be big, please
38+
[open an issue][enhancement] first so we can discuss it.
39+
- Improving this `README` or adding other documentation to `httpsig`.
40+
- Letting [me] know if you're using `httpsig`.
41+
42+
43+
<!-- Other links -->
44+
[go]: https://golang.org
45+
[msgsig]: https://datatracker.ietf.org/doc/draft-ietf-httpbis-message-signatures/
46+
[dighdr]: https://datatracker.ietf.org/doc/draft-ietf-httpbis-digest-headers/
47+
48+
[issues]: ./issues
49+
[bug]: ./issues/new?labels=bug
50+
[enhancement]: ./issues/new?labels=enhancement
51+
52+
[me]: https://twitter.com/jrbowes

0 commit comments

Comments
 (0)