spatie/ssl-certificate

A class to easily query the properties of an ssl certificate

A class to validate SSL certificates

, _(*1)

The class provided by this package makes it incredibly easy to query the properties on an ssl certificate. We have three options for fetching a certficate. Here's an example:, _(*2)

use Spatie\SslCertificate\SslCertificate;

// fetch the certificate using an url
$certificate = SslCertificate::createForHostName('spatie.be');

// or from a certificate file
$certificate = SslCertificate::createFromFile($pathToCertificateFile);

// or from a string
$certificate = SslCertificate::createFromString($certificateData);

$certificate->isValid(); // returns true if the certificate is currently valid

$certificate->expirationDate(); // returns a Carbon instance Carbon
$certificate->validFromDate(); // returns a Carbon instance Carbon

$certificate->daysUntilExpirationDate(); // returns the amount of days between today and expirationDate
$certificate->lifespanInDays(); // return the amount of days between validFromDate and expirationDate

$certificate->getIssuer(); // returns "Let's Encrypt Authority X3"
$certificate->getOrganization(); // returns the organization name when available
$certificate->getPublicKeyAlgorithm(); // returns the public key algorithm
$certificate->getPublicKeySize(); // returns the public key algorithm
$certificate->getSignatureAlgorithm(); // returns the signature algorithm

Downloading invalid certificate

If you want to download certificates even if they are invalid (for example, if they are expired), you can pass a $verifyCertificate boolean to SslCertificate::createFromHostname() as the third argument, for example:, _(*3)

$certificate = SslCertificate::createForHostName('expired.badssl.com', $timeoutInSeconds, false);

About us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*4)

Support us

, _(*5)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*6)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*7)

Installation

You can install the package via composer:, _(*8)

composer require spatie/ssl-certificate

Important notice

Currently, this package does not check if the certificate is signed by a trusted authority. We'll add this check soon in a next point release., _(*9)

Usage

You can create an instance of Spatie\SslCertificate\SslCertificate with this named constructor:, _(*10)

$certificate = SslCertificate::createForHostName('spatie.be');

You can create an instance of Spatie\SslCertificate\SslCertificate passing the port with this named constructor:, _(*11)

$certificate = SslCertificate::createForHostName('spatie.be:443');

You can use this fluent style to specify a specific port to connect to., _(*12)

SslCertificate::download()
   ->usingPort($customPort)
   ->forHost($hostName);

You can check the certificate on a different IP address using the same style., _(*13)

SslCertificate::download()
   ->fromIpAddress($ipAddress)
   ->forHost($hostName);

This also works with IPv6 addresses, _(*14)

SslCertificate::download()
    ->fromIpAddress('2a00:1450:4001:80e::200e')
    ->forHost('google.com');

You can specify socket context options., _(*15)

SslCertificate::download()
   ->withSocketContextOptions([
      'option' => 'value',
   ])
   ->forHost($hostName);

If the given ipAddress is invalid Spatie\SslCertificate\Exceptions\InvalidIpAddress will be thrown., _(*16)

If the given hostName is invalid Spatie\SslCertificate\Exceptions\InvalidUrl will be thrown., _(*17)

If the given hostName is valid but there was a problem downloading the certifcate Spatie\SslCertificate\Exceptions\CouldNotDownloadCertificate will be thrown., _(*18)

Getting the issuer name

$certificate->getIssuer(); // returns "Let's Encrypt Authority X3"

Getting the domain name

Returns the primary domain name for the certificate, _(*19)

$certificate->getDomain(); // returns "spatie.be"

Getting the certificate's signing algorithm

Returns the algorithm used for signing the certificate, _(*20)

$certificate->getSignatureAlgorithm(); // returns "RSA-SHA256"

Getting the certificate's organization

Returns the organization belonging to the certificate, _(*21)

$certificate->getOrganization(); // returns "Spatie BVBA"

Getting the additional domain names

A certificate can cover multiple (sub)domains. Here's how to get them., _(*22)

$certificate->getAdditionalDomains(); // returns ["spatie.be", "www.spatie.be]

A domain name return with this method can start with * meaning it is valid for all subdomains of that domain., _(*23)

Getting the fingerprint

$certificate->getFingerprint(); // returns a fingerprint for the certificate

Getting the SHA256 fingerprint

$certificate->getFingerprintSha256(); // returns a SHA256 fingerprint for the certificate

Getting the date when the certificate becomes valid

$certificate->validFromDate(); // returns an instance of Carbon

Getting the expiration date

$certificate->expirationDate(); // returns an instance of Carbon

Determining if the certificate is still valid

Returns true if the current Date and time is between validFromDate and expirationDate., _(*24)

$certificate->isValid(); // returns a boolean

You also use this method to determine if a given domain is covered by the certificate. Of course it'll keep checking if the current Date and time is between validFromDate and expirationDate., _(*25)

$certificate->isValid('spatie.be'); // returns true;
$certificate->isValid('laravel.com'); // returns false;

Determining if the certificate is still valid until a given date

Returns true if the certificate is valid and if the expirationDate is after the given date., _(*26)

$certificate->isValidUntil(Carbon::now()->addDays(7)); // returns a boolean

Determining if the certificate is expired

$certificate->isExpired(); // returns a boolean if expired

Convert the certificate to an array

You can convert a certificate to an array using the toArray method., _(*27)

$certificateProperties = $certificate->toArray();

The properties can be used to create a new instance of the certificate., _(*28)

\Spatie\SslCertificate\SslCertificate::createFromArray($certificateProperties);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently., _(*29)

Contributing

Please see CONTRIBUTING for details., _(*30)

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities., _(*31)

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., _(*32)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., _(*33)

We publish all received postcards on our company website., _(*34)

Credits

• Freek Van der Herten
• All Contributors

The helper functions and tests were copied from the Laravel Framework., _(*35)

License

The MIT License (MIT). Please see License File for more information., _(*36)