PHP download

Download the PHP package ivan-novakov/php-haveibeenpwned-client without Composer

On this page you can find all versions of the php package ivan-novakov/php-haveibeenpwned-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download ivan-novakov/php-haveibeenpwned-client
More information about ivan-novakov/php-haveibeenpwned-client
Files in ivan-novakov/php-haveibeenpwned-client

Vendor ivan-novakov
Package php-haveibeenpwned-client
Short Description A PHP client library and CLI for haveibeenpwned.com
License BSD-3-Clause
Homepage https://github.com/ivan-novakov/php-haveibeenpwned-client

Keywords php cli client haveibeenpwned

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of ivan-novakov/php-haveibeenpwned-client

Informations about the package php-haveibeenpwned-client

PHP Client for haveibeenpwned.com

Introduction

The haveibeenpwned.com site is a project by Troy Hunt which allows you to check, if your account has been compromised in a recent password disclosure by submitting an email address. You can find more info about the site in the corresponding blogpost.

The site also provides a RESTful remote API. This library is a simple PHP client implementation, which can interact with that API. It is both a client library and a client CLI - you can use it in your project or you can use the provided CLI.

Features

lightweight and easily extendable
SSL support with peer verification
ready to use CLI

Dependencies

PHP >= 5.3.4
zendframework/zend-http - the ZF2 HTTP client implementation
zendframework/zend-json - the ZF2 JSON encoder/decoder implementation
symfony/console - the Console component from the Symfony object, used to implement the CLI
cURL - for SSL support

Installation

The easiest way to install the library is through composer.

To use it as a standalone CLI:

To add it to your project:

CLI

The library comes with ready to use command line interface based on the Symfony Console component.

Usage:

Options:

--ssl - Use SSL when connecting to the remote service
--ca-file - Use an alternative CA file
--plain - Use simple output, suitable for parsing
--show-exceptions - Show the exception (if any) instead of the error message, suitable for debugging

Library

Basic usage

The checkEmail() method returns either null if the email has not been pwned, or an array of site names, where the corresponding account has been compromised. In case of an error an exception is thrown.

SSL connections

By default a HTTP connection is used. To enforce a SSL connection you need to initialize the service with the use_ssl option:

The library uses the cURL PHP extension to handle SSL connections. It is configured to perform peer and host verification (CURLOPT_SSL_VERIFYPEER = true, CURLOPT_SSL_VERIFYHOST = 2). For more information on how to handle SSL connections in PHP (ZF2), see my blogpost HTTPS connections with Zend Framework 2.

The peer is verified against the CA root certificate of the haveibeenpwned.com site. The CA root certificate is stored in ssl/ca-bundle.pem. If for some reason you need to change that, you can specify alternative path to the bundle:

Exceptions

InoHibp\Exception\InvalidEmailException - the site has returned status code 400, which means, that the email has wrong format
InoHibp\Exception\UnexpectedResponseException - unexpected status code, anything different from the supported codes (see the docs)
InoHibp\Exception\InvalidResponseFormatException - thrown when the status code is 200 and a JSON encoded list of sites is expected, but the parsing fails
InoHibp\Exception\TransportException - HTTP connection error
InoHibp\Exception\InvalidCaFileException - indicates a problem with the file containing the root CA certificate of the server (unreadable, invalid format, etc.)

License

BSD 3 Clause

Author

Ivan Novakov

All versions of php-haveibeenpwned-client with dependencies

PHP Build Version

Package Version

Version 1.0.1 Release 11. Dec 2013
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of php-haveibeenpwned-client from vendor ivan-novakov

Requires php Version >=5.3.4
zendframework/zend-http Version ~2
zendframework/zend-json Version ~2
symfony/console Version ~2

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ivan-novakov/php-haveibeenpwned-client contains the following files

Loading the files please wait ....