NAME

WebService::SSLLabs::Host - Host object

VERSION

Version 0.33

SUBROUTINES/METHODS

new

a new WebService::SSLLabs::Host object, accepts a hash ref as it's parameter.

complete

will return the current WebService::SSLLabs::Host object if status is READY or ERROR. Otherwise it will return undef assessment status; possible values: DNS, ERROR, IN_PROGRESS, and READY.

ready

will return the current WebService::SSLLabs::Host object if status is equal to READY. Otherwise it will return undef.

eta

will return the highest of any of the eta values from the available endpoints.

host

assessment host, which can be a hostname or an IP address

port

assessment port (e.g., 443)

protocol

protocol (e.g., HTTP)

is_public

true if this assessment publicly available (listed on the SSL Labs assessment boards)

status

assessment status; possible values: DNS, ERROR, IN_PROGRESS, and READY.

status_message

status message in English. When status is ERROR, this field will contain an error message.

start_time

assessment starting time, in milliseconds since 1970

test_time

assessment completion time, in milliseconds since 1970

engine_version

assessment engine version (e.g., "1.0.180")

criteria_version

grading criteria version (e.g., "2009")

cache_expiry_time

when will the assessment results expire from the cache (typically set only for assessment with errors; otherwise the results stay in the cache for as long as there's sufficient room)

endpoints

list of Endpoint objects

cert_hostnames

the list of certificate hostnames collected from the certificates seen during assessment. The hostnames may not be valid. This field is available only if the server certificate doesn't match the requested hostname. In that case, this field saves you some time as you don't have to inspect the certificates yourself to find out what valid hostnames might be.

DIAGNOSTICS

None

CONFIGURATION AND ENVIRONMENT

WebService::SSLLabs::Host requires no configuration files or environment variables.

DEPENDENCIES

WebService::SSLLabs::Host requires no non-core modules

INCOMPATIBILITIES

None reported

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-net-ssllabs at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-SSLLabs. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

David Dick, <ddick at cpan.org>

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WebService::SSLLabs::Host

You can also look for information at:

• RT: CPAN's request tracker (report bugs here)

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-SSLLabs

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/WebService-SSLLabs

• CPAN Ratings

  http://cpanratings.perl.org/d/WebService-SSLLabs

• Search CPAN

  http://search.cpan.org/dist/WebService-SSLLabs/

ACKNOWLEDGEMENTS

Thanks to Ivan Ristic and the team at https://www.qualys.com for providing the service at https://www.ssllabs.com

POD was extracted from the API help at https://github.com/ssllabs/ssllabs-scan/blob/stable/ssllabs-api-docs.md

LICENSE AND COPYRIGHT

Copyright 2016 David Dick.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

cpanm WebService::SSLLabs

perl -MCPAN -e shell
install WebService::SSLLabs