view release on metacpan or  search on metacpan

lib/XML/Compile/WSS/Sign.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

XML::Compile::WSS::Sign - Base for WSS Signers

=head1 INHERITANCE

 XML::Compile::WSS::Sign is extended by
   XML::Compile::WSS::Sign::HMAC
   XML::Compile::WSS::Sign::RSA

=head1 SYNOPSIS

  # either
  use XML::Compile::WSS::Util qw/DSIG_RSA_SHA1/;
  my $sign = XML::Compile::WSS::Sign->new
    ( sign_method => DSIG_RSA_SHA1
    , private_key => $key
    , ...
    );

  # or
  use XML::Compile::WSS::Sign::RSA;
  my $sign = XML::Compile::WSS::Sign::RSA->new
    ( hashing     => 'SHA1'
    , private_key => $key
    , ...
    );

=head1 DESCRIPTION

=head2 Supported signers

=over 4

=item * RSA

=back

Hire me to implement other signers!

=head1 METHODS

=head2 Constructors

=over 4

=item XML::Compile::WSS::Sign-E<gt>B<fromConfig>(HASH|PAIRS)

Try to be very flexible.  CONFIG can be a HASH, which could also be
passed to L<new()|XML::Compile::WSS::Sign/"Constructors"> directly.  But it can also be various kinds of
objects.

=item XML::Compile::WSS::Sign-E<gt>B<new>(%options)

 -Option     --Default
  sign_method  DSIG_RSA_SHA1

=over 2

=item sign_method => TYPE

=back

=back

=head2 Attributes

=over 4

=item $obj-E<gt>B<signMethod>()

=back

=head2 Handlers

=over 4

=item $obj-E<gt>B<builder>()

=item $obj-E<gt>B<checker>()

=back

=head1 DETAILS