christopherrabotin / gin-contrib-headerauth Goto Github PK

Reading the examples provided definitely helps, but a quick start would be much easier. This issue should also detail how we can use header based auth without a signature.

Current code coverage is 96.7%, with line 50 not being covered:

github.com/ChristopherRabotin/gin-contrib-signedauth/signatureauth.go:49.23,51.6 1 0

A simple test for this is adding a Manager which will fail on the DataToSign function, and test the status is valid.

It could also be of interest to add the coverage profile on the README.

As per the docs, this module would be easier and more idiomatic if the auth manager would be like this:

type MyManager struct{
   SomeField interface{}
   *signedauth.Manager
}
mgr := &MyManager{{}, signedauth.Manager{AuthPrefix: "EXAMPLE", ...}}

I must check whether it's possible in go then to call a function which the Manager expects, e.g. SecretKey (which will be handled differently depending on the manager), although that function won't be defined by signedauth.Manager.

These can be used to set custom headers, but also perform specific actions. Provided parameters will be the Gin context, the access key used, the signature used, the secret, the dataToSign, as well as the error.

These should be sufficient to handle HTTP Basic Auth.

Example: https://github.com/gin-gonic/gin/blob/master/auth.go#L51 .

Use example from https://github.com/gin-gonic/contrib/blob/master/.travis.yml.