https://github.com/mamantoha/http-client-digest_auth

An implementation of RFC 2617 Digest Access Authentication for Crystal
https://github.com/mamantoha/http-client-digest_auth

crystal digest-authentication http-client

Last synced: 7 months ago
JSON representation

An implementation of RFC 2617 Digest Access Authentication for Crystal

• Host: GitHub
• URL: https://github.com/mamantoha/http-client-digest_auth
• Owner: mamantoha
• License: mit
• Created: 2019-09-07T09:43:46.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-21T08:44:14.000Z (over 2 years ago)
• Last Synced: 2025-02-09T20:16:25.952Z (about 1 year ago)
• Topics: crystal, digest-authentication, http-client
• Language: Crystal
• Homepage:
• Size: 19.5 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HTTP::Client::DigestAuth

![Crystal CI](https://github.com/mamantoha/http-client-digest_auth/workflows/Crystal%20CI/badge.svg)

[![GitHub release](https://img.shields.io/github/release/mamantoha/http-client-digest_auth.svg)](https://github.com/mamantoha/http-client-digest_auth/releases)

[![License](https://img.shields.io/github/license/mamantoha/http-client-digest_auth.svg)](https://github.com/mamantoha/http-client-digest_auth/blob/master/LICENSE)

An implementation of RFC 2617 - Digest Access Authentication. At this time

this library does not drop in to `HTTP::Client` and can be used for with other HTTP

clients.

[crest](https://github.com/mamantoha/crest) uses this shard to provide _Digest Access Authentication_ support out of the box.

In order to use `http-client-digest_auth` you'll need to perform some request

wrangling on your own. See the class documentation at `HTTP::Client::DigestAuth`

for an example.

Ported from Ruby's [net-http-digest_auth](https://github.com/drbrain/net-http-digest_auth) gem.

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  http-client-digest_auth:

    github: mamantoha/http-client-digest_auth

```

## Usage

```crystal

require "http/client"

require "uri"

require "http-client-digest_auth"

url = "https://httpbin.org/digest-auth/auth/admin/passwd/MD5"

uri = URI.parse(url)

uri.user = "admin"

uri.password = "passwd"

client = HTTP::Client.new(uri)

response = client.get(uri.full_path)

# response is a 401 response with a WWW-Authenticate header

www_authenticate = response.headers["WWW-Authenticate"]

digest_auth = HTTP::Client::DigestAuth.new

auth = digest_auth.auth_header(uri, www_authenticate, "GET")

http_headers = HTTP::Headers.new

http_headers["Authorization"] = auth

# re-issue request with Authorization

response = client.get(uri.full_path, http_headers)

```

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer