PHPackages                             bdunogier/guzzle-site-authenticator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. bdunogier/guzzle-site-authenticator

ActiveLibrary[HTTP & Networking](/categories/http)

bdunogier/guzzle-site-authenticator
===================================

A guzzle plugin that adds, if necessary, authentication data to requests. Uses credentials and cookies, with login requests to the sites.

1.1.0(2y ago)4209.4k↑528.8%6[4 issues](https://github.com/wallabag/guzzle-site-authenticator/issues)[1 PRs](https://github.com/wallabag/guzzle-site-authenticator/pulls)1MITPHPCI failing

Since Jan 17Pushed 2y ago4 watchersCompare

[ Source](https://github.com/wallabag/guzzle-site-authenticator)[ Packagist](https://packagist.org/packages/bdunogier/guzzle-site-authenticator)[ RSS](/packages/bdunogier-guzzle-site-authenticator/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (7)Dependencies (10)Versions (9)Used By (1)

Guzzle site authenticator
=========================

[](#guzzle-site-authenticator)

[![CI](https://github.com/wallabag/guzzle-site-authenticator/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/wallabag/guzzle-site-authenticator/actions/workflows/continuous-integration.yml)

This package is a plugin for [guzzle](http://packagist.org/packages/guzzlehttp/guzzle) 5.x. It provides a subscriber that can authenticate requests by posting login information.

It comes up as a Symfony bundle and a generic php lib.

Installation
------------

[](#installation)

### Using composer

[](#using-composer)

Add the package to your requirements using composer: `composer require bdunogier/guzzle-site-authenticator`.

If you're using the Symfony fullstack, add `BD\GuzzleSiteAuthenticatorBundle\BDGuzzleSiteAuthenticatorBundle` to your kernel class.

Usage
-----

[](#usage)

The guzzle subscriber, `Guzzle\AuthenticatorSubscriber`, must be attached to the Guzzle client. It is provided by the bundle as `@bd_guzzle_site_authenticator.authenticator_subscriber`:

```
$client = new GuzzleHttp\Client(['defaults' => ['cookies' => new FileCookieJar('/tmp/cookiejar.json')]]);
$client->getEmitter()->attach(
    $container->get('bd_guzzle_site_authenticator.authenticator_subscriber')
);
```

### Cookies handling

[](#cookies-handling)

The `CookieJar` passed to the guzzle client defaults is important: it will be used read/write cookies received by Guzzle, and is required for authentication to work.

Send a request with Guzzle. If the request's host has a SiteConfig that requires configuration (see below), the plugin will try to log in to the site if it does not have a cookie yet. After a request, if the response contains the not logged in text (matched by xpath), it tries to login again, and retries the request.

Site configuration
------------------

[](#site-configuration)

Login to sites configured via `SiteConfig` objects:

```
$siteConfig = new BD\GuzzleSiteAuthenticator\SiteConfig\SiteConfig([
    'host' => 'example.com',
    'loginUri' => 'http://example.com/login',
    'usernameField' => 'username',
    'passwordField' => 'password',
    'extraFields' => ['action' => 'login'],
    'notLoggedInXpath' => "//div[@class='not-logged-in']",
    'username' => "johndoe",
    'password' => "unknown",
]);
```

`SiteConfig` objects are returned by a `SiteConfigBuilder`. The library comes with a default `ArraySiteConfigBuilder`, that accepts a list of site config properties array, indexed by host. With the bundle, its contents can be configured using the `bd_guzzle_site_authenticator.site_config` container variable:

```
# config.yml
parameters:
    bd_guzzle_site_authenticator.site_config:
        example.com:
            host: "example.com"
            loginUri: "http://example.com/login"
            usernameField: "username"
            passwordField: "password"
            extraFields: {action: login}
            notLoggedInXpath: "//div[@class='not-logged-in']"
            username: "johndoe"
            password: "unknown"
        otherexample.com:
            host: ...
```

Implementations
---------------

[](#implementations)

Used by [wallabag](http://github.com/wallabag/wallabag), a read it later web application, to fetch content from sites that require a login.

It implements a custom `SiteConfigBuilder`, based on sites configuration provided by [j0k3r/graby](http://github.com/j0k3r/graby).

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity39

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 60.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~462 days

Recently: every ~570 days

Total

7

Last Release

1048d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/235928?v=4)[Bertrand Dunogier](/maintainers/bdunogier)[@bdunogier](https://github.com/bdunogier)

![](https://avatars.githubusercontent.com/u/62333?v=4)[Jérémy Benoist](/maintainers/j0k3r)[@j0k3r](https://github.com/j0k3r)

![](https://www.gravatar.com/avatar/b2919c3e1996b6ab5cb88d77183334f92c4ae8318e02860bd04320c3d6628147?d=identicon)[nicosomb](/maintainers/nicosomb)

---

Top Contributors

[![j0k3r](https://avatars.githubusercontent.com/u/62333?v=4)](https://github.com/j0k3r "j0k3r (34 commits)")[![yguedidi](https://avatars.githubusercontent.com/u/1480128?v=4)](https://github.com/yguedidi "yguedidi (12 commits)")[![bdunogier](https://avatars.githubusercontent.com/u/235928?v=4)](https://github.com/bdunogier "bdunogier (6 commits)")[![elibadou384](https://avatars.githubusercontent.com/u/41485348?v=4)](https://github.com/elibadou384 "elibadou384 (2 commits)")[![Kdecherf](https://avatars.githubusercontent.com/u/226063?v=4)](https://github.com/Kdecherf "Kdecherf (2 commits)")

---

Tags

authenticationguzzlephp

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/bdunogier-guzzle-site-authenticator/health.svg)

```
[![Health](https://phpackages.com/badges/bdunogier-guzzle-site-authenticator/health.svg)](https://phpackages.com/packages/bdunogier-guzzle-site-authenticator)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)