/usr/share/perl5/Net/EPP/Protocol.pm is in libnet-epp-perl 0.19-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | # Copyright (c) 2012 CentralNic Ltd. All rights reserved. This program is
# free software; you can redistribute it and/or modify it under the same
# terms as Perl itself.
package Net::EPP::Protocol;
use bytes;
use Carp;
use strict;
=pod
=head1 NAME
Net::EPP::Protocol - Low-level functions useful for both EPP clients and
servers.
=head1 SYNOPSIS
#!/usr/bin/perl
use Net::EPP::Protocol;
use IO::Socket;
use strict;
# create a socket:
my $socket = IO::Socket::INET->new( ... );
# send a frame down the socket:
Net::EPP::Protocol->send_frame($socket, $xml);
# get a frame from the socket:
my $xml = Net::EPP::Protocol->get_frame($socket);
=head1 DESCRIPTION
EPP is the Extensible Provisioning Protocol. EPP (defined in RFC 4930)
is an application layer client-server protocol for the provisioning and
management of objects stored in a shared central repository. Specified
in XML, the protocol defines generic object management operations and an
extensible framework that maps protocol operations to objects. As of
writing, its only well-developed application is the provisioning of
Internet domain names, hosts, and related contact details.
This module implements functions that are common to both EPP clients and
servers that implement the TCP transport as defined in RFC 4934. The
main consumer of this module is currently L<Net::EPP::Client>.
=head1 METHODS
my $xml = Net::EPP::Protocol->get_frame($socket);
This method reads a frame from the socket and returns a scalar
containing the XML. C<$socket> must be an L<IO::Handle> or one of its
subclasses (ie C<IO::Socket::*>).
If the transmission fails for whatever reason, this method will
C<croak()>, so be sure to enclose it in an C<eval()>.
=cut
sub get_frame {
my ($class, $fh) = @_;
my $hdr;
if (!defined($fh->read($hdr, 4))) {
croak("Got a bad frame length from peer - connection closed?");
} else {
my $length = (unpack('N', $hdr) - 4);
if ($length < 0) {
croak("Got a bad frame length from peer - connection closed?");
} elsif (0 == $length) {
croak('Frame length is zero');
} else {
my $xml = '';
my $buffer;
while (length($xml) < $length) {
$buffer = '';
$fh->read($buffer, ($length - length($xml)));
last if (length($buffer) == 0); # in case the socket has closed
$xml .= $buffer;
}
return $xml;
}
}
}
=pod
Net::EPP::Protocol->send_frame($socket, $xml);
This method prepares an RFC 4934 compliant EPP frame and transmits it to
the remote peer. C<$socket> must be an L<IO::Handle> or one of its
subclasses (ie C<IO::Socket::*>).
If the transmission fails for whatever reason, this method will
C<croak()>, so be sure to enclose it in an C<eval()>. Otherwise, it will
return a true value.
=cut
sub send_frame {
my ($class, $fh, $xml) = @_;
$fh->print($class->prep_frame($xml));
$fh->flush;
return 1;
}
=pod
my $frame = Net::EPP::Protocol->prep_frame($xml);
This method returns the XML frame in "wire format" with the protocol
header prepended to it. The return value can be printed directly to an
open socket, for example:
print STDOUT Net::EPP::Protocol->prep_frame($frame->toString);
=cut
sub prep_frame {
my ($class, $xml) = @_;
return pack('N', length($xml) + 4).$xml;
}
=pod
=head1 AUTHOR
CentralNic Ltd (L<http://www.centralnic.com/>).
=head1 COPYRIGHT
This module is (c) 2012 CentralNic Ltd. This module is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 SEE ALSO
=over
=item * L<Net::EPP::Client>
=item * RFCs 4930 and RFC 4934, available from L<http://www.ietf.org/>.
=item * The CentralNic EPP site at L<http://www.centralnic.com/resellers/epp>.
=back
=cut
1;
|