Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spider-gazelle/digest-auth

HTTP digest auth for crystal lang
https://github.com/spider-gazelle/digest-auth

Last synced: about 2 months ago
JSON representation

HTTP digest auth for crystal lang

Awesome Lists containing this project

README

        

# Crystal Lang Digest Auth

[![CI](https://github.com/spider-gazelle/digest-auth/actions/workflows/ci.yml/badge.svg)](https://github.com/spider-gazelle/digest-auth/actions/workflows/ci.yml)

Communicate with servers that implement digest auth.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
digest-auth:
github: spider-gazelle/digest-auth
```

2. Run `shards install`

## Usage

```crystal
require "http/client"
require "digest-auth"

# New client per-connection, this keeps track of nonce count
digest_auth = DigestAuth.new

uri = URI.parse "http://foo.com/posts?id=30&limit=5"

# if you expect digest auth use a head request to get the challenge header
client = HTTP::Client.new uri
response = client.head uri.full_path
response.status_code # => 401

challenge = response.headers["WWW-Authenticate"]
uri.user = "username"
uri.password = "password"

# Generate the auth header, need to indicate if talking to IIS
auth_header = digest_auth.auth_header(uri, challenge, "get", iis: false)

# Make the request
response = client.get uri.full_path, HTTP::Headers{ "Authorization" => auth_header }
response.status_code # => 200

# Make a second request while the connection is still open
uri.path = "/posts/30"
auth_header = digest_auth.auth_header(uri, challenge, "post", iis: false)
response = client.post uri.full_path, HTTP::Headers{ "Authorization" => auth_header }, body: "hello!"
response.status_code # => 201
```

or using `.before_request`

```crystal
require "http/client"
require "digest-auth"

digest_auth = DigestAuth.new
uri = URI.parse "http://foo.com/"

client = HTTP::Client.new uri
response = client.head uri.full_path
response.status_code # => 401

challenge = response.headers["WWW-Authenticate"]
uri.user = "username"
uri.password = "password"

client.before_request do |request|
req_path = URI.parse request.resource
uri.path = req_path.path
uri.query = req_path.query
auth_header = digest_auth.auth_header(uri, challenge, request.method, iis: false)
request.headers["Authorization"] = auth_header
end

client.get "/"
client.post "/some_path", body: "hello!"
```