Skip Menu |
 

This queue is for tickets about the Net-SSLGlue CPAN distribution.

Report information
The Basics
Id: 46284
Status: resolved
Priority: 0/
Queue: Net-SSLGlue

People
Owner: Nobody in particular
Requestors: dom [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Unimportant
Broken in: 0.2
Fixed in: (no value)

Attachments


Subject: Improve English of documentation
Download (untitled) / with headers
text/plain 351b
In a number of locations the English in the POD could be improved. Mostly these are style and grammar fixes, although in the introduction there is one missing word which I've added (checking). Patch attached. Thanks for a useful module, even if it is a bit depressing that in 2009 it's not done correctly by default... I've now uploaded it to Debian.
Subject: Net-SSLGlue-English.patch
diff -x .svn -urN trunk/lib/Net/SSLGlue/LDAP.pm trunk.mine/lib/Net/SSLGlue/LDAP.pm --- trunk/lib/Net/SSLGlue/LDAP.pm 2009-05-20 17:58:45.000000000 +0100 +++ trunk.mine/lib/Net/SSLGlue/LDAP.pm 2009-05-21 17:51:30.000000000 +0100 @@ -43,13 +43,13 @@ L<Net::SSLGlue::LDAP> modifies L<Net::LDAP> so that it does proper certificate checking using the C<ldap> SSL_verify_scheme from L<IO::Socket::SSL>. -Because L<Net::LDAP> does not have a mechanism to forward arbitrary parameter for +Because L<Net::LDAP> does not have a mechanism to forward arbitrary parameters for the construction of the underlying socket these parameters can be set globally -when including the package or with local settings of the +when including the package, or with local settings of the C<%Net::SSLGlue::LDAP::SSLopts> variable. -All of the C<SSL_*> parameter from L<IO::Socket::SSL> can be used, especially -the following parameter is useful: +All of the C<SSL_*> parameters from L<IO::Socket::SSL> can be used; the +following parameter is especially useful: =over 4 @@ -57,7 +57,7 @@ Usually the name given as the hostname in the constructor is used to verify the identity of the certificate. If you want to check the certificate against -another name you might specify it with this parameter. +another name you can specify it with this parameter. =back diff -x .svn -urN trunk/lib/Net/SSLGlue/LWP.pm trunk.mine/lib/Net/SSLGlue/LWP.pm --- trunk/lib/Net/SSLGlue/LWP.pm 2009-05-20 17:58:45.000000000 +0100 +++ trunk.mine/lib/Net/SSLGlue/LWP.pm 2009-05-21 17:54:31.000000000 +0100 @@ -136,35 +136,35 @@ =head1 DESCRIPTION L<Net::SSLGlue::LWP> modifies L<Net::HTTPS> and L<LWP::Protocol::https> so that -L<Net::HTTPS> is forced to use L<IO::Socket::SSL> instead of L<Crypt::SSLeay> +L<Net::HTTPS> is forced to use L<IO::Socket::SSL> instead of L<Crypt::SSLeay>, and that L<LWP::Protocol::https> does proper certificate checking using the C<http> SSL_verify_scheme from L<IO::Socket::SSL>. -Because L<LWP> does not have a mechanism to forward arbitrary parameter for +Because L<LWP> does not have a mechanism to forward arbitrary parameters for the construction of the underlying socket these parameters can be set globally -when including the package or with local settings of the +when including the package, or with local settings of the C<%Net::SSLGlue::LWP::SSLopts> variable. -All of the C<SSL_*> parameter from L<IO::Socket::SSL> can be used, especially -the following parameters are useful: +All of the C<SSL_*> parameter from L<IO::Socket::SSL> can be used; the +following parameters are especially useful: =over 4 =item SSL_ca_path, SSL_ca_file Specifies the path or a file where the CAs used for checking the certificates -are located. Typical for UNIX systems is L</etc/ssl/certs>. +are located. This is typically L</etc/ssl/certs> on UNIX systems. =item SSL_verify_mode -If set to 0 disabled verification of the certificate. By default it is 1 which -means, that the peer certificate is checked. +If set to 0, verification of the certificate will be disabled. By default +it is set to 1 which means that the peer certificate is checked. =item SSL_verifycn_name Usually the name given as the hostname in the constructor is used to verify the identity of the certificate. If you want to check the certificate against -another name you might specify it with this parameter. +another name you can specify it with this parameter. =back diff -x .svn -urN trunk/lib/Net/SSLGlue/SMTP.pm trunk.mine/lib/Net/SSLGlue/SMTP.pm --- trunk/lib/Net/SSLGlue/SMTP.pm 2009-05-20 17:58:45.000000000 +0100 +++ trunk.mine/lib/Net/SSLGlue/SMTP.pm 2009-05-21 17:57:24.000000000 +0100 @@ -120,10 +120,10 @@ =head1 DESCRIPTION -L<Net::SSLGlue::SMTP> expands L<Net::SMTP> so one can either start directly with SSL +L<Net::SSLGlue::SMTP> extends L<Net::SMTP> so one can either start directly with SSL or switch later to SSL using the STARTTLS command. -By default it will take care to verfify the certificate according to the rules +By default it will take care to verify the certificate according to the rules for SMTP implemented in L<IO::Socket::SSL>. =head1 METHODS @@ -152,26 +152,26 @@ =back All of these methods can take the C<SSL_*> parameter from L<IO::Socket::SSL> to -change the behavior of the SSL connection. Especially the following parameter -are useful: +change the behavior of the SSL connection. The following parameters are +especially useful: =over 4 =item SSL_ca_path, SSL_ca_file Specifies the path or a file where the CAs used for checking the certificates -are located. Typical for UNIX systems is L</etc/ssl/certs>. +are located. This is typically L</etc/ssl/certs> on UNIX systems. =item SSL_verify_mode -If set to 0 disabled verification of the certificate. By default it is 1 which -means, that the peer certificate is checked. +If set to 0, verification of the certificate will be disabled. By default +it is set to 1 which means that the peer certificate is checked. =item SSL_verifycn_name Usually the name given as the hostname in the constructor is used to verify the identity of the certificate. If you want to check the certificate against -another name you might specify it with this parameter. +another name you can specify it with this parameter. =back diff -x .svn -urN trunk/lib/Net/SSLGlue.pm trunk.mine/lib/Net/SSLGlue.pm --- trunk/lib/Net/SSLGlue.pm 2009-05-21 17:57:51.000000000 +0100 +++ trunk.mine/lib/Net/SSLGlue.pm 2009-05-21 17:47:17.000000000 +0100 @@ -8,11 +8,12 @@ =head1 DESCRIPTION Some commonly used perl modules don't have SSL support at all, even if the -protocol would support it. Others have SSL support, but most of them don't do -proper checking of the servers certificate. +protocol supports it. Others have SSL support, but most of them don't do +proper checking of the server's certificate. -The C<Net::SSLGlue::*> modules try to add SSL support or proper certificate to -these modules. Currently is support for the following modules available: +The C<Net::SSLGlue::*> modules try to add SSL support or proper certificate +checking to these modules. Currently support for the following modules is +available: =over 4 @@ -26,7 +27,7 @@ =head1 COPYRIGHT -This module and the modules in the Net::SSLGlue Hierarchy distributed together +This module and the modules in the Net::SSLGlue hierarchy distributed together with this module are copyright (c) 2008, Steffen Ullrich. All Rights Reserved. These modules are free software. They may be used, redistributed and/or modified
Download (untitled) / with headers
text/plain 293b
I don't know why I ignored this ticket for such a long time, but I must have seen it in a busy time and then forgotten about it. Sorry for that. But now I've finally applied your patch. Thanks a lot for your input, and hopefully your next input will be included much faster. Regards, Steffen


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.