Skip to content

Commit

Permalink
Minor readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
AvnerCohen committed Aug 25, 2020
1 parent 97bb810 commit c66d21a
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,13 @@
[![Gem Version](https://badge.fury.io/rb/http-headers-verifier.svg)](https://badge.fury.io/rb/http-headers-verifier)
[![Build Status](https://travis-ci.org/AvnerCohen/http-headers-verifier.svg?branch=master)](https://travis-ci.org/AvnerCohen/http-headers-verifier)

Verify a pre-defined HTTP headers configurations.
Assertation framework for http-headers on top of live endpoints, Verify a pre-defined HTTP headers configurations.

Unlike some other similar projects, this is not meant to enforce best practices, instead it is meant to define policies on top of headers and enforce them.
As a side effect, this means you can define specific OWASP (for example) best practices and verify them, but unlike testing for best practices, this is inteneded to verify an expected headers configuration behavior.

Relevant use cases are for example when updating nginx/caddy configuration or when moving from one web-server to another and expecting to maintain a specific set of header config.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'http-headers-verifier'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install http-headers-verifier

### Usage

```sh
Expand Down Expand Up @@ -65,6 +50,22 @@ Starting verification of policies default, hs-default, hs-production:
😱 Failed !
```

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'http-headers-verifier'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install http-headers-verifier


### Configuration

Expand Down

0 comments on commit c66d21a

Please sign in to comment.