doc fixes
Karel Miko
6 years ago
3 | 3 | |
4 | 4 | use strict; |
5 | 5 | use warnings; |
6 | our $VERSION = '0.001'; | |
6 | our $VERSION = '0.052'; | |
7 | 7 | |
8 | 8 | use Crypt::Cipher; |
9 | 9 | use base 'Crypt::Mode'; |
40 | 40 | [%-END%] |
41 | 41 | my $ciphertext = $m->add('some data'); |
42 | 42 | $ciphertext .= $m->add('more data'); |
43 | [%-IF lc_name == 'ecb' or lc_name == 'cbc' %] | |
43 | [%-IF lc_name == 'ecb' or lc_name == 'cbc' %] | |
44 | 44 | $ciphertext .= $m->finish; |
45 | 45 | [%-END%] |
46 | 46 | |
114 | 114 | |
115 | 115 | =head2 start_encrypt |
116 | 116 | |
117 | See example below L</finish>. | |
117 | [%-IF lc_name == 'ecb' %] | |
118 | $m->start_encrypt($key); | |
119 | [%-ELSE%] | |
120 | $m->start_encrypt($key, $iv); | |
121 | [%-END%] | |
118 | 122 | |
119 | 123 | =head2 start_decrypt |
120 | 124 | |
121 | See example below L</finish>. | |
125 | [%-IF lc_name == 'ecb' %] | |
126 | $m->start_decrypt($key); | |
127 | [%-ELSE%] | |
128 | $m->start_decrypt($key, $iv); | |
129 | [%-END%] | |
122 | 130 | |
123 | 131 | =head2 add |
124 | 132 | |
125 | See example below L</finish>. | |
133 | # in encrypt mode | |
134 | my $plaintext = $m->add($ciphertext); | |
126 | 135 | |
136 | # in decrypt mode | |
137 | my $ciphertext = $m->add($plaintext); | |
138 | ||
139 | [%-IF lc_name == 'ecb' or lc_name == 'cbc' %] | |
127 | 140 | =head2 finish |
128 | 141 | |
129 | 142 | #encrypt more chunks |
152 | 165 | $plaintext .= $m->finish; |
153 | 166 | [%-END%] |
154 | 167 | |
168 | [%-END%] | |
155 | 169 | =head1 SEE ALSO |
156 | 170 | |
157 | 171 | =over |
15 | 15 | |
16 | 16 | die "No args given!\n" unless $ARGV[0]; |
17 | 17 | my $outdir_l = ($ARGV[0] eq 'install_code') ? catdir($FindBin::Bin, "..", "lib") : ''; |
18 | my $outdir_i = ($ARGV[0] eq 'install_code') ? catdir($FindBin::Bin, "..", "inc") : ''; | |
18 | 19 | my $outdir_t = ($ARGV[0] eq 'install_tests') ? catdir($FindBin::Bin, "..", "t") : ''; |
19 | 20 | warn "STARTED: outdir_l='$outdir_l' outdir_t='$outdir_t'\n"; |
20 | 21 | |
71 | 72 | #unlink "$t_out.$$"; |
72 | 73 | } |
73 | 74 | |
74 | if ($outdir_l) { | |
75 | if ($outdir_l && $outdir_i) { | |
75 | 76 | if (1) { # if($n ne 'CBC' || $n ne 'ECB') { |
76 | my $xs_out = catfile($outdir_l, "CryptX_Mode_$n.xs.inc"); | |
77 | my $xs_out = catfile($outdir_i, "CryptX_Mode_$n.xs.inc"); | |
77 | 78 | my $xs_tt = Template->new(ABSOLUTE=>1) || die $Template::ERROR, "\n"; |
78 | 79 | if ($n eq 'CBC' || $n eq 'ECB') { |
79 | 80 | $xs_tt->process("$FindBin::Bin/Mode_p.xs.inc.tt", $data, "$xs_out.$$", {binmode=>1}) || die $xs_tt->error(), "\n"; |
68 | 68 | |
69 | 69 | =head2 start_encrypt |
70 | 70 | |
71 | See example below L</finish>. | |
71 | $m->start_encrypt($key, $iv); | |
72 | 72 | |
73 | 73 | =head2 start_decrypt |
74 | 74 | |
75 | See example below L</finish>. | |
75 | $m->start_decrypt($key, $iv); | |
76 | 76 | |
77 | 77 | =head2 add |
78 | 78 | |
79 | See example below L</finish>. | |
79 | # in encrypt mode | |
80 | my $plaintext = $m->add($ciphertext); | |
81 | ||
82 | # in decrypt mode | |
83 | my $ciphertext = $m->add($plaintext); | |
80 | 84 | |
81 | 85 | =head2 finish |
82 | 86 |
61 | 61 | |
62 | 62 | =head2 start_encrypt |
63 | 63 | |
64 | See example below L</finish>. | |
64 | $m->start_encrypt($key, $iv); | |
65 | 65 | |
66 | 66 | =head2 start_decrypt |
67 | 67 | |
68 | See example below L</finish>. | |
68 | $m->start_decrypt($key, $iv); | |
69 | 69 | |
70 | 70 | =head2 add |
71 | 71 | |
72 | See example below L</finish>. | |
72 | # in encrypt mode | |
73 | my $plaintext = $m->add($ciphertext); | |
73 | 74 | |
74 | =head2 finish | |
75 | ||
76 | #encrypt more chunks | |
77 | $m->start_encrypt($key, $iv); | |
78 | my $ciphertext = ''; | |
79 | $ciphertext .= $m->add('some data'); | |
80 | $ciphertext .= $m->add('more data'); | |
81 | ||
82 | #decrypt more chunks | |
83 | $m->start_decrypt($key, $iv); | |
84 | my $plaintext = ''; | |
85 | $plaintext .= $m->add($some_ciphertext); | |
86 | $plaintext .= $m->add($more_ciphertext); | |
75 | # in decrypt mode | |
76 | my $ciphertext = $m->add($plaintext); | |
87 | 77 | |
88 | 78 | =head1 SEE ALSO |
89 | 79 |
68 | 68 | |
69 | 69 | =head2 start_encrypt |
70 | 70 | |
71 | See example below L</finish>. | |
71 | $m->start_encrypt($key, $iv); | |
72 | 72 | |
73 | 73 | =head2 start_decrypt |
74 | 74 | |
75 | See example below L</finish>. | |
75 | $m->start_decrypt($key, $iv); | |
76 | 76 | |
77 | 77 | =head2 add |
78 | 78 | |
79 | See example below L</finish>. | |
79 | # in encrypt mode | |
80 | my $plaintext = $m->add($ciphertext); | |
80 | 81 | |
81 | =head2 finish | |
82 | ||
83 | #encrypt more chunks | |
84 | $m->start_encrypt($key, $iv); | |
85 | my $ciphertext = ''; | |
86 | $ciphertext .= $m->add('some data'); | |
87 | $ciphertext .= $m->add('more data'); | |
88 | ||
89 | #decrypt more chunks | |
90 | $m->start_decrypt($key, $iv); | |
91 | my $plaintext = ''; | |
92 | $plaintext .= $m->add($some_ciphertext); | |
93 | $plaintext .= $m->add($more_ciphertext); | |
82 | # in decrypt mode | |
83 | my $ciphertext = $m->add($plaintext); | |
94 | 84 | |
95 | 85 | =head1 SEE ALSO |
96 | 86 |
69 | 69 | |
70 | 70 | =head2 start_encrypt |
71 | 71 | |
72 | See example below L</finish>. | |
72 | $m->start_encrypt($key); | |
73 | 73 | |
74 | 74 | =head2 start_decrypt |
75 | 75 | |
76 | See example below L</finish>. | |
76 | $m->start_decrypt($key); | |
77 | 77 | |
78 | 78 | =head2 add |
79 | 79 | |
80 | See example below L</finish>. | |
80 | # in encrypt mode | |
81 | my $plaintext = $m->add($ciphertext); | |
82 | ||
83 | # in decrypt mode | |
84 | my $ciphertext = $m->add($plaintext); | |
81 | 85 | |
82 | 86 | =head2 finish |
83 | 87 |
61 | 61 | |
62 | 62 | =head2 start_encrypt |
63 | 63 | |
64 | See example below L</finish>. | |
64 | $m->start_encrypt($key, $iv); | |
65 | 65 | |
66 | 66 | =head2 start_decrypt |
67 | 67 | |
68 | See example below L</finish>. | |
68 | $m->start_decrypt($key, $iv); | |
69 | 69 | |
70 | 70 | =head2 add |
71 | 71 | |
72 | See example below L</finish>. | |
72 | # in encrypt mode | |
73 | my $plaintext = $m->add($ciphertext); | |
73 | 74 | |
74 | =head2 finish | |
75 | ||
76 | #encrypt more chunks | |
77 | $m->start_encrypt($key, $iv); | |
78 | my $ciphertext = ''; | |
79 | $ciphertext .= $m->add('some data'); | |
80 | $ciphertext .= $m->add('more data'); | |
81 | ||
82 | #decrypt more chunks | |
83 | $m->start_decrypt($key, $iv); | |
84 | my $plaintext = ''; | |
85 | $plaintext .= $m->add($some_ciphertext); | |
86 | $plaintext .= $m->add($more_ciphertext); | |
75 | # in decrypt mode | |
76 | my $ciphertext = $m->add($plaintext); | |
87 | 77 | |
88 | 78 | =head1 SEE ALSO |
89 | 79 |
484 | 484 | |
485 | 485 | =item * RSA public key from X509 certificate |
486 | 486 | |
487 | -----BEGIN CERTIFICATE----- | |
488 | MIIC8zCCAdugAwIBAgIJAPi+LvMU3uGWMA0GCSqGSIb3DQEBCwUAMBAxDjAMBgNV | |
489 | BAMMBXBva3VzMB4XDTE3MDcxNDE0MTAyMFoXDTIwMDQwOTE0MTAyMFowEDEOMAwG | |
490 | A1UEAwwFcG9rdXMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCQima | |
491 | SUIMIdz5uVevzcScbcj06xs1OLaFKUoPJ8v+xP6Ut61BQhAvc8GYuw2uRx223hZC | |
492 | r3HYLfSdWIfmOIAtlL8cPYPVoSivJtpSGE6fBG1tlBjVgXWRmJGR/oxx6Y5QDwcB | |
493 | Q4GZKga8TtHQoY5idZuatYOFZGfMIcIUC0Uoda+YSypnw7A90F/JvlpcTUh3Fnem | |
494 | VinqEA6XOegU9dCZk/29sXqauBjbdGihh8DvpklOhY16eQoiR3909AywQ0KUmI+R | |
495 | Sa9E8oIsmUDetFuXEvana+sD3y42tU+cd2nhBPRETbSXPcum0B3uF4yKgweuJy5D | |
496 | cvtVQIFVkkh4+AWNAgMBAAGjUDBOMB0GA1UdDgQWBBSS6V5PVGyN92NoB0AVLcOb | |
497 | pzR3SzAfBgNVHSMEGDAWgBSS6V5PVGyN92NoB0AVLcObpzR3SzAMBgNVHRMEBTAD | |
498 | AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBIszrBjoJ39axsS6Btbvwvo8vAmgiSWsav | |
499 | 7AmjXOAwknHPaCcDmrdOys5POD0DNRwNeRsnxFiZ/UL8Vmj2JGDLgAw+/v32MwfX | |
500 | Ig7m+oIbO8KqDzlYvS5kd3suJ5C21hHy1/JUtfofZLovZH7ZRzhTAoRvCYaodW90 | |
501 | 2o8ZqmyCdcXPzjFmoJ2xYzs/Sf8/E1cHfb+4HjOpeRnKxDvG0gwWzcsXpUrw2pNO | |
502 | Oztj6Rd0THNrf/anIeYVtAHX4aqZA8Kbv2TyJd+9g78usFw1cn+8vfmilm6Pn0DQ | |
503 | a+I5GyGd7BJI8wYuWqIStzvrJHbQQaNrSk7hgjWYiYlcsPh6w2QP | |
504 | -----END CERTIFICATE----- | |
487 | -----BEGIN CERTIFICATE----- | |
488 | MIIC8zCCAdugAwIBAgIJAPi+LvMU3uGWMA0GCSqGSIb3DQEBCwUAMBAxDjAMBgNV | |
489 | BAMMBXBva3VzMB4XDTE3MDcxNDE0MTAyMFoXDTIwMDQwOTE0MTAyMFowEDEOMAwG | |
490 | A1UEAwwFcG9rdXMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCQima | |
491 | SUIMIdz5uVevzcScbcj06xs1OLaFKUoPJ8v+xP6Ut61BQhAvc8GYuw2uRx223hZC | |
492 | r3HYLfSdWIfmOIAtlL8cPYPVoSivJtpSGE6fBG1tlBjVgXWRmJGR/oxx6Y5QDwcB | |
493 | Q4GZKga8TtHQoY5idZuatYOFZGfMIcIUC0Uoda+YSypnw7A90F/JvlpcTUh3Fnem | |
494 | VinqEA6XOegU9dCZk/29sXqauBjbdGihh8DvpklOhY16eQoiR3909AywQ0KUmI+R | |
495 | Sa9E8oIsmUDetFuXEvana+sD3y42tU+cd2nhBPRETbSXPcum0B3uF4yKgweuJy5D | |
496 | cvtVQIFVkkh4+AWNAgMBAAGjUDBOMB0GA1UdDgQWBBSS6V5PVGyN92NoB0AVLcOb | |
497 | pzR3SzAfBgNVHSMEGDAWgBSS6V5PVGyN92NoB0AVLcObpzR3SzAMBgNVHRMEBTAD | |
498 | AQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBIszrBjoJ39axsS6Btbvwvo8vAmgiSWsav | |
499 | 7AmjXOAwknHPaCcDmrdOys5POD0DNRwNeRsnxFiZ/UL8Vmj2JGDLgAw+/v32MwfX | |
500 | Ig7m+oIbO8KqDzlYvS5kd3suJ5C21hHy1/JUtfofZLovZH7ZRzhTAoRvCYaodW90 | |
501 | 2o8ZqmyCdcXPzjFmoJ2xYzs/Sf8/E1cHfb+4HjOpeRnKxDvG0gwWzcsXpUrw2pNO | |
502 | Oztj6Rd0THNrf/anIeYVtAHX4aqZA8Kbv2TyJd+9g78usFw1cn+8vfmilm6Pn0DQ | |
503 | a+I5GyGd7BJI8wYuWqIStzvrJHbQQaNrSk7hgjWYiYlcsPh6w2QP | |
504 | -----END CERTIFICATE----- | |
505 | 505 | |
506 | 506 | =item * SSH public RSA keys |
507 | 507 |