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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OpenSSL::Cipher - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-OpenSSL::Cipher-label-Listing+all+supported+algorithms">Listing all supported algorithms</a>
<li><a href="#class-OpenSSL::Cipher-label-Instantiating+a+Cipher">Instantiating a Cipher</a>
<li><a href="#class-OpenSSL::Cipher-label-Choosing+either+encryption+or+decryption+mode">Choosing either encryption or decryption mode</a>
<li><a href="#class-OpenSSL::Cipher-label-Choosing+a+key">Choosing a key</a>
<li><a href="#class-OpenSSL::Cipher-label-Choosing+an+IV">Choosing an IV</a>
<li><a href="#class-OpenSSL::Cipher-label-Calling+Cipher-23final">Calling Cipher#final</a>
<li><a href="#class-OpenSSL::Cipher-label-Encrypting+and+decrypting+some+data">Encrypting and decrypting some data</a>
<li><a href="#class-OpenSSL::Cipher-label-Authenticated+Encryption+and+Associated+Data+-28AEAD-29">Authenticated Encryption and Associated Data (AEAD)</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-ciphers">::ciphers</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-auth_data-3D">#auth_data=</a>
<li ><a href="#method-i-auth_tag">#auth_tag</a>
<li ><a href="#method-i-auth_tag-3D">#auth_tag=</a>
<li ><a href="#method-i-auth_tag_len-3D">#auth_tag_len=</a>
<li ><a href="#method-i-authenticated-3F">#authenticated?</a>
<li ><a href="#method-i-block_size">#block_size</a>
<li ><a href="#method-i-ccm_data_len-3D">#ccm_data_len=</a>
<li ><a href="#method-i-decrypt">#decrypt</a>
<li ><a href="#method-i-encrypt">#encrypt</a>
<li ><a href="#method-i-final">#final</a>
<li ><a href="#method-i-initialize_copy">#initialize_copy</a>
<li ><a href="#method-i-iv-3D">#iv=</a>
<li ><a href="#method-i-iv_len">#iv_len</a>
<li ><a href="#method-i-iv_len-3D">#iv_len=</a>
<li ><a href="#method-i-key-3D">#key=</a>
<li ><a href="#method-i-key_len">#key_len</a>
<li ><a href="#method-i-key_len-3D">#key_len=</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-padding-3D">#padding=</a>
<li ><a href="#method-i-pkcs5_keyivgen">#pkcs5_keyivgen</a>
<li ><a href="#method-i-random_iv">#random_iv</a>
<li ><a href="#method-i-random_key">#random_key</a>
<li ><a href="#method-i-reset">#reset</a>
<li ><a href="#method-i-update">#update</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OpenSSL::Cipher">
<h1 id="class-OpenSSL::Cipher" class="class">
class OpenSSL::Cipher
</h1>
<section class="description">
<p>Provides symmetric algorithms for encryption and decryption. The algorithms that are available depend on the particular version of <a href="../OpenSSL.html"><code>OpenSSL</code></a> that is installed.</p>
<h3 id="class-OpenSSL::Cipher-label-Listing+all+supported+algorithms">Listing all supported algorithms<span><a href="#class-OpenSSL::Cipher-label-Listing+all+supported+algorithms">¶</a> <a href="#top">↑</a></span></h3>
<p>A list of supported algorithms can be obtained by</p>
<pre class="ruby"><span class="ruby-identifier">puts</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">ciphers</span>
</pre>
<h3 id="class-OpenSSL::Cipher-label-Instantiating+a+Cipher">Instantiating a <a href="Cipher/Cipher.html"><code>Cipher</code></a><span><a href="#class-OpenSSL::Cipher-label-Instantiating+a+Cipher">¶</a> <a href="#top">↑</a></span></h3>
<p>There are several ways to create a <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance. Generally, a <a href="Cipher/Cipher.html"><code>Cipher</code></a> algorithm is categorized by its name, the key length in bits and the cipher mode to be used. The most generic way to create a <a href="Cipher/Cipher.html"><code>Cipher</code></a> is the following</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'<name>-<key length>-<mode>'</span>)
</pre>
<p>That is, a string consisting of the hyphenated concatenation of the individual components name, key length and mode. Either all uppercase or all lowercase strings may be used, for example:</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-128-cbc'</span>)
</pre>
<h3 id="class-OpenSSL::Cipher-label-Choosing+either+encryption+or+decryption+mode">Choosing either encryption or decryption mode<span><a href="#class-OpenSSL::Cipher-label-Choosing+either+encryption+or+decryption+mode">¶</a> <a href="#top">↑</a></span></h3>
<p>Encryption and decryption are often very similar operations for symmetric algorithms, this is reflected by not having to choose different classes for either operation, both can be done using the same class. Still, after obtaining a <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance, we need to tell the instance what it is that we intend to do with it, so we need to call either</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">encrypt</span>
</pre>
<p>or</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">decrypt</span>
</pre>
<p>on the <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance. This should be the first call after creating the instance, otherwise configuration that has already been set could get lost in the process.</p>
<h3 id="class-OpenSSL::Cipher-label-Choosing+a+key">Choosing a key<span><a href="#class-OpenSSL::Cipher-label-Choosing+a+key">¶</a> <a href="#top">↑</a></span></h3>
<p>Symmetric encryption requires a key that is the same for the encrypting and for the decrypting party and after initial key establishment should be kept as private information. There are a lot of ways to create insecure keys, the most notable is to simply take a password as the key without processing the password further. A simple and secure way to create a key for a particular <a href="Cipher/Cipher.html"><code>Cipher</code></a> is</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-256-cfb'</span>)
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">encrypt</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">random_key</span> <span class="ruby-comment"># also sets the generated key on the Cipher</span>
</pre>
<p>If you absolutely need to use passwords as encryption keys, you should use Password-Based Key Derivation Function 2 (PBKDF2) by generating the key with the help of the functionality provided by <a href="PKCS5.html#method-i-pbkdf2_hmac_sha1"><code>OpenSSL::PKCS5.pbkdf2_hmac_sha1</code></a> or <a href="PKCS5.html#method-i-pbkdf2_hmac"><code>OpenSSL::PKCS5.pbkdf2_hmac</code></a>.</p>
<p>Although there is <a href="Cipher.html#method-i-pkcs5_keyivgen"><code>Cipher#pkcs5_keyivgen</code></a>, its use is deprecated and it should only be used in legacy applications because it does not use the newer PKCS#5 v2 algorithms.</p>
<h3 id="class-OpenSSL::Cipher-label-Choosing+an+IV">Choosing an IV<span><a href="#class-OpenSSL::Cipher-label-Choosing+an+IV">¶</a> <a href="#top">↑</a></span></h3>
<p>The cipher modes CBC, CFB, OFB and CTR all need an “initialization vector”, or short, IV. ECB mode is the only mode that does not require an IV, but there is almost no legitimate use case for this mode because of the fact that it does not sufficiently hide plaintext patterns. Therefore</p>
<p><strong>You should never use ECB mode unless you are absolutely sure that you absolutely need it</strong></p>
<p>Because of this, you will end up with a mode that explicitly requires an IV in any case. Although the IV can be seen as public information, i.e. it may be transmitted in public once generated, it should still stay unpredictable to prevent certain kinds of attacks. Therefore, ideally</p>
<p><strong>Always create a secure random IV for every encryption of your Cipher</strong></p>
<p>A new, random IV should be created for every encryption of data. Think of the IV as a nonce (number used once) - it’s public but random and unpredictable. A secure random IV can be created as follows</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-operator">...</span>
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">encrypt</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">random_key</span>
<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">random_iv</span> <span class="ruby-comment"># also sets the generated IV on the Cipher</span>
</pre>
<p>Although the key is generally a random value, too, it is a bad choice as an IV. There are elaborate ways how an attacker can take advantage of such an IV. As a general rule of thumb, exposing the key directly or indirectly should be avoided at all cost and exceptions only be made with good reason.</p>
<h3 id="class-OpenSSL::Cipher-label-Calling+Cipher-23final">Calling <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a><span><a href="#class-OpenSSL::Cipher-label-Calling+Cipher-23final">¶</a> <a href="#top">↑</a></span></h3>
<p>ECB (which should not be used) and CBC are both block-based modes. This means that unlike for the other streaming-based modes, they operate on fixed-size blocks of data, and therefore they require a “finalization” step to produce or correctly decrypt the last block of data by appropriately handling some form of padding. Therefore it is essential to add the output of <a href="Cipher.html#method-i-final"><code>OpenSSL::Cipher#final</code></a> to your encryption/decryption buffer or you will end up with decryption errors or truncated data.</p>
<p>Although this is not really necessary for streaming-mode ciphers, it is still recommended to apply the same pattern of adding the output of <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a> there as well - it also enables you to switch between modes more easily in the future.</p>
<h3 id="class-OpenSSL::Cipher-label-Encrypting+and+decrypting+some+data">Encrypting and decrypting some data<span><a href="#class-OpenSSL::Cipher-label-Encrypting+and+decrypting+some+data">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">data</span> = <span class="ruby-string">"Very, very confidential data"</span>
<span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-128-cbc'</span>)
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">encrypt</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">random_key</span>
<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">random_iv</span>
<span class="ruby-identifier">encrypted</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">data</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
<span class="ruby-operator">...</span>
<span class="ruby-identifier">decipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-128-cbc'</span>)
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">decrypt</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">iv</span>
<span class="ruby-identifier">plain</span> = <span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">encrypted</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">final</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">plain</span> <span class="ruby-comment">#=> true</span>
</pre>
<h3 id="class-OpenSSL::Cipher-label-Authenticated+Encryption+and+Associated+Data+-28AEAD-29">Authenticated Encryption and Associated Data (AEAD)<span><a href="#class-OpenSSL::Cipher-label-Authenticated+Encryption+and+Associated+Data+-28AEAD-29">¶</a> <a href="#top">↑</a></span></h3>
<p>If the <a href="../OpenSSL.html"><code>OpenSSL</code></a> version used supports it, an Authenticated Encryption mode (such as GCM or CCM) should always be preferred over any unauthenticated mode. Currently, <a href="../OpenSSL.html"><code>OpenSSL</code></a> supports AE only in combination with Associated Data (AEAD) where additional associated data is included in the encryption process to compute a tag at the end of the encryption. This tag will also be used in the decryption process and by verifying its validity, the authenticity of a given ciphertext is established.</p>
<p>This is superior to unauthenticated modes in that it allows to detect if somebody effectively changed the ciphertext after it had been encrypted. This prevents malicious modifications of the ciphertext that could otherwise be exploited to modify ciphertexts in ways beneficial to potential attackers.</p>
<p>An associated data is used where there is additional information, such as headers or some metadata, that must be also authenticated but not necessarily need to be encrypted. If no associated data is needed for encryption and later decryption, the <a href="../OpenSSL.html"><code>OpenSSL</code></a> library still requires a value to be set - “” may be used in case none is available.</p>
<p>An example using the GCM (Galois/Counter Mode). You have 16 bytes <em>key</em>, 12 bytes (96 bits) <em>nonce</em> and the associated data <em>auth_data</em>. Be sure not to reuse the <em>key</em> and <em>nonce</em> pair. Reusing an nonce ruins the security guarantees of GCM mode.</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-128-gcm'</span>).<span class="ruby-identifier">encrypt</span>
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">nonce</span>
<span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">auth_data</span> = <span class="ruby-identifier">auth_data</span>
<span class="ruby-identifier">encrypted</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">data</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">final</span>
<span class="ruby-identifier">tag</span> = <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">auth_tag</span> <span class="ruby-comment"># produces 16 bytes tag by default</span>
</pre>
<p>Now you are the receiver. You know the <em>key</em> and have received <em>nonce</em>, <em>auth_data</em>, <em>encrypted</em> and <em>tag</em> through an untrusted network. Note that GCM accepts an arbitrary length tag between 1 and 16 bytes. You may additionally need to check that the received tag has the correct length, or you allow attackers to forge a valid single byte tag for the tampered ciphertext with a probability of 1/256.</p>
<pre class="ruby"><span class="ruby-identifier">raise</span> <span class="ruby-string">"tag is truncated!"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">tag</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">==</span> <span class="ruby-value">16</span>
<span class="ruby-identifier">decipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'aes-128-gcm'</span>).<span class="ruby-identifier">decrypt</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">nonce</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">auth_tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">auth_data</span> = <span class="ruby-identifier">auth_data</span>
<span class="ruby-identifier">decrypted</span> = <span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">encrypted</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">decipher</span>.<span class="ruby-identifier">final</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">decrypted</span> <span class="ruby-comment">#=> true</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-ciphers" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
OpenSSL::Cipher.ciphers → array[string...]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the names of all available ciphers in an array.</p>
<div class="method-source-code" id="ciphers-source">
<pre>static VALUE
ossl_s_ciphers(VALUE self)
{
VALUE ary;
ary = rb_ary_new();
OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
add_cipher_name_to_ary,
(void*)ary);
return ary;
}</pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
new(string) → cipher
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The string must contain a valid cipher name like “aes-256-cbc”.</p>
<p>A list of cipher names is available by calling <a href="Cipher.html#method-c-ciphers"><code>OpenSSL::Cipher.ciphers</code></a>.</p>
<div class="method-source-code" id="new-source">
<pre>static VALUE
ossl_cipher_initialize(VALUE self, VALUE str)
{
EVP_CIPHER_CTX *ctx;
const EVP_CIPHER *cipher;
char *name;
name = StringValueCStr(str);
GetCipherInit(self, ctx);
if (ctx) {
ossl_raise(rb_eRuntimeError, "Cipher already initialized!");
}
AllocCipher(self, ctx);
if (!(cipher = EVP_get_cipherbyname(name))) {
ossl_raise(rb_eRuntimeError, "unsupported cipher algorithm (%"PRIsVALUE")", str);
}
if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, -1) != 1)
ossl_raise(eCipherError, NULL);
return self;
}</pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-auth_data-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
auth_data = string → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the cipher’s additional authenticated data. This field must be set when using AEAD cipher modes such as GCM or CCM. If no associated data shall be used, this method must <strong>still</strong> be called with a value of “”. The contents of this field should be non-sensitive data which will be added to the ciphertext to generate the authentication tag which validates the contents of the ciphertext.</p>
<p>The AAD must be set prior to encryption or decryption. In encryption mode, it must be set after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> and setting <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a>. When decrypting, the authenticated data must be set after key, iv and especially <strong>after</strong> the authentication tag has been set. I.e. set it only after calling <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>, <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a>, <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a> and <a href="Cipher.html#method-i-auth_tag-3D"><code>Cipher#auth_tag=</code></a> first.</p>
<div class="method-source-code" id="auth_data-3D-source">
<pre>static VALUE
ossl_cipher_set_auth_data(VALUE self, VALUE data)
{
EVP_CIPHER_CTX *ctx;
unsigned char *in;
long in_len, out_len;
StringValue(data);
in = (unsigned char *) RSTRING_PTR(data);
in_len = RSTRING_LEN(data);
GetCipher(self, ctx);
if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER))
ossl_raise(eCipherError, "AEAD not supported by this cipher");
if (!ossl_cipher_update_long(ctx, NULL, &out_len, in, in_len))
ossl_raise(eCipherError, "couldn't set additional authenticated data");
return data;
}</pre>
</div>
</div>
</div>
<div id="method-i-auth_tag" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
auth_tag(tag_len = 16) → String
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Gets the authentication tag generated by Authenticated Encryption <a href="Cipher/Cipher.html"><code>Cipher</code></a> modes (GCM for example). This tag may be stored along with the ciphertext, then set on the decryption cipher to authenticate the contents of the ciphertext against changes. If the optional integer parameter <em>tag_len</em> is given, the returned tag will be <em>tag_len</em> bytes long. If the parameter is omitted, the default length of 16 bytes or the length previously set by <a href="Cipher.html#method-i-auth_tag_len-3D"><code>auth_tag_len=</code></a> will be used. For maximum security, the longest possible should be chosen.</p>
<p>The tag may only be retrieved after calling <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>.</p>
<div class="method-source-code" id="auth_tag-source">
<pre>static VALUE
ossl_cipher_get_auth_tag(int argc, VALUE *argv, VALUE self)
{
VALUE vtag_len, ret;
EVP_CIPHER_CTX *ctx;
int tag_len = 16;
rb_scan_args(argc, argv, "01", &vtag_len);
if (NIL_P(vtag_len))
vtag_len = rb_attr_get(self, id_auth_tag_len);
if (!NIL_P(vtag_len))
tag_len = NUM2INT(vtag_len);
GetCipher(self, ctx);
if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER))
ossl_raise(eCipherError, "authentication tag not supported by this cipher");
ret = rb_str_new(NULL, tag_len);
if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, tag_len, RSTRING_PTR(ret)))
ossl_raise(eCipherError, "retrieving the authentication tag failed");
return ret;
}</pre>
</div>
</div>
</div>
<div id="method-i-auth_tag-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
auth_tag = string → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the authentication tag to verify the integrity of the ciphertext. This can be called only when the cipher supports AE. The tag must be set after calling <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>, <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a>, but before calling <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>. After all decryption is performed, the tag is verified automatically in the call to <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>.</p>
<p>For OCB mode, the tag length must be supplied with <a href="Cipher.html#method-i-auth_tag_len-3D"><code>auth_tag_len=</code></a> beforehand.</p>
<div class="method-source-code" id="auth_tag-3D-source">
<pre>static VALUE
ossl_cipher_set_auth_tag(VALUE self, VALUE vtag)
{
EVP_CIPHER_CTX *ctx;
unsigned char *tag;
int tag_len;
StringValue(vtag);
tag = (unsigned char *) RSTRING_PTR(vtag);
tag_len = RSTRING_LENINT(vtag);
GetCipher(self, ctx);
if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER))
ossl_raise(eCipherError, "authentication tag not supported by this cipher");
if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, tag_len, tag))
ossl_raise(eCipherError, "unable to set AEAD tag");
return vtag;
}</pre>
</div>
</div>
</div>
<div id="method-i-auth_tag_len-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
auth_tag_len = Integer → Integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires it as in input parameter. Note that not all AEAD ciphers support this method.</p>
<p>In OCB mode, the length must be supplied both when encrypting and when decrypting, and must be before specifying an IV.</p>
<div class="method-source-code" id="auth_tag_len-3D-source">
<pre>static VALUE
ossl_cipher_set_auth_tag_len(VALUE self, VALUE vlen)
{
int tag_len = NUM2INT(vlen);
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER))
ossl_raise(eCipherError, "AEAD not supported by this cipher");
if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, tag_len, NULL))
ossl_raise(eCipherError, "unable to set authentication tag length");
/* for #auth_tag */
rb_ivar_set(self, id_auth_tag_len, INT2NUM(tag_len));
return vlen;
}</pre>
</div>
</div>
</div>
<div id="method-i-authenticated-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
authenticated? → true | false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Indicated whether this <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance uses an Authenticated Encryption mode.</p>
<div class="method-source-code" id="authenticated-3F-source">
<pre>static VALUE
ossl_cipher_is_authenticated(VALUE self)
{
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
return (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) ? Qtrue : Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-block_size" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
block_size → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the size in bytes of the blocks on which this <a href="Cipher/Cipher.html"><code>Cipher</code></a> operates on.</p>
<div class="method-source-code" id="block_size-source">
<pre>static VALUE
ossl_cipher_block_size(VALUE self)
{
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
return INT2NUM(EVP_CIPHER_CTX_block_size(ctx));
}</pre>
</div>
</div>
</div>
<div id="method-i-ccm_data_len-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
ccm_data_len = integer → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to call this method after <a href="Cipher.html#method-i-key-3D"><code>key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>iv=</code></a> have been set, and before <a href="Cipher.html#method-i-auth_data-3D"><code>auth_data=</code></a>.</p>
<p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p>
<div class="method-source-code" id="ccm_data_len-3D-source">
<pre>static VALUE
ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len)
{
int in_len, out_len;
EVP_CIPHER_CTX *ctx;
in_len = NUM2INT(data_len);
GetCipher(self, ctx);
if (EVP_CipherUpdate(ctx, NULL, &out_len, NULL, in_len) != 1)
ossl_raise(eCipherError, NULL);
return data_len;
}</pre>
</div>
</div>
</div>
<div id="method-i-decrypt" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
decrypt → self
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes the <a href="Cipher/Cipher.html"><code>Cipher</code></a> for decryption.</p>
<p>Make sure to call <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a> before using any of the following methods:</p>
<ul><li><dl class="rdoc-list label-list"><dt><a href="Cipher.html#method-i-key-3D"><code>key=</code></a>, <a href="Cipher.html#method-i-iv-3D"><code>iv=</code></a>, <a href="Cipher.html#method-i-random_key"><code>random_key</code></a>, <a href="Cipher.html#method-i-random_iv"><code>random_iv</code></a>, <a href="Cipher.html#method-i-pkcs5_keyivgen"><code>pkcs5_keyivgen</code></a>
<dd></dd></dl>
</li></ul>
<p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 0).</p>
<div class="method-source-code" id="decrypt-source">
<pre>static VALUE
ossl_cipher_decrypt(int argc, VALUE *argv, VALUE self)
{
return ossl_cipher_init(argc, argv, self, 0);
}</pre>
</div>
</div>
</div>
<div id="method-i-encrypt" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
encrypt → self
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes the <a href="Cipher/Cipher.html"><code>Cipher</code></a> for encryption.</p>
<p>Make sure to call <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a> before using any of the following methods:</p>
<ul><li><dl class="rdoc-list label-list"><dt><a href="Cipher.html#method-i-key-3D"><code>key=</code></a>, <a href="Cipher.html#method-i-iv-3D"><code>iv=</code></a>, <a href="Cipher.html#method-i-random_key"><code>random_key</code></a>, <a href="Cipher.html#method-i-random_iv"><code>random_iv</code></a>, <a href="Cipher.html#method-i-pkcs5_keyivgen"><code>pkcs5_keyivgen</code></a>
<dd></dd></dl>
</li></ul>
<p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 1).</p>
<div class="method-source-code" id="encrypt-source">
<pre>static VALUE
ossl_cipher_encrypt(int argc, VALUE *argv, VALUE self)
{
return ossl_cipher_init(argc, argv, self, 1);
}</pre>
</div>
</div>
</div>
<div id="method-i-final" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
final → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the remaining data held in the cipher object. Further calls to <a href="Cipher.html#method-i-update"><code>Cipher#update</code></a> or <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a> will return garbage. This call should always be made as the last call of an encryption or decryption operation, after having fed the entire plaintext or ciphertext to the <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance.</p>
<p>If an authenticated cipher was used, a <a href="Cipher/CipherError.html"><code>CipherError</code></a> is raised if the tag could not be authenticated successfully. Only call this method after setting the authentication tag and passing the entire contents of the ciphertext into the cipher.</p>
<div class="method-source-code" id="final-source">
<pre>static VALUE
ossl_cipher_final(VALUE self)
{
EVP_CIPHER_CTX *ctx;
int out_len;
VALUE str;
GetCipher(self, ctx);
str = rb_str_new(0, EVP_CIPHER_CTX_block_size(ctx));
if (!EVP_CipherFinal_ex(ctx, (unsigned char *)RSTRING_PTR(str), &out_len))
ossl_raise(eCipherError, NULL);
assert(out_len <= RSTRING_LEN(str));
rb_str_set_len(str, out_len);
return str;
}</pre>
</div>
</div>
</div>
<div id="method-i-initialize_copy" class="method-detail ">
<div class="method-heading">
<span class="method-name">initialize_copy</span><span
class="method-args">(p1)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="initialize_copy-source">
<pre>static VALUE
ossl_cipher_copy(VALUE self, VALUE other)
{
EVP_CIPHER_CTX *ctx1, *ctx2;
rb_check_frozen(self);
if (self == other) return self;
GetCipherInit(self, ctx1);
if (!ctx1) {
AllocCipher(self, ctx1);
}
GetCipher(other, ctx2);
if (EVP_CIPHER_CTX_copy(ctx1, ctx2) != 1)
ossl_raise(eCipherError, NULL);
return self;
}</pre>
</div>
</div>
</div>
<div id="method-i-iv-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
iv = string → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly required and should be set prior to encryption. The IV itself can be safely transmitted in public, but it should be unpredictable to prevent certain kinds of attacks. You may use <a href="Cipher.html#method-i-random_iv"><code>Cipher#random_iv</code></a> to create a secure random IV.</p>
<p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p>
<div class="method-source-code" id="iv-3D-source">
<pre>static VALUE
ossl_cipher_set_iv(VALUE self, VALUE iv)
{
EVP_CIPHER_CTX *ctx;
int iv_len = 0;
StringValue(iv);
GetCipher(self, ctx);
if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)
iv_len = (int)(VALUE)EVP_CIPHER_CTX_get_app_data(ctx);
if (!iv_len)
iv_len = EVP_CIPHER_CTX_iv_length(ctx);
if (RSTRING_LEN(iv) != iv_len)
ossl_raise(rb_eArgError, "iv must be %d bytes", iv_len);
if (EVP_CipherInit_ex(ctx, NULL, NULL, NULL, (unsigned char *)RSTRING_PTR(iv), -1) != 1)
ossl_raise(eCipherError, NULL);
return iv;
}</pre>
</div>
</div>
</div>
<div id="method-i-iv_len" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
iv_len → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the expected length in bytes for an IV for this <a href="Cipher/Cipher.html"><code>Cipher</code></a>.</p>
<div class="method-source-code" id="iv_len-source">
<pre>static VALUE
ossl_cipher_iv_length(VALUE self)
{
EVP_CIPHER_CTX *ctx;
int len = 0;
GetCipher(self, ctx);
if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER)
len = (int)(VALUE)EVP_CIPHER_CTX_get_app_data(ctx);
if (!len)
len = EVP_CIPHER_CTX_iv_length(ctx);
return INT2NUM(len);
}</pre>
</div>
</div>
</div>
<div id="method-i-iv_len-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
iv_len = integer → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the IV/nonce length of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>. Normally block ciphers don’t allow changing the IV length, but some make use of IV for ‘nonce’. You may need this for interoperability with other applications.</p>
<div class="method-source-code" id="iv_len-3D-source">
<pre>static VALUE
ossl_cipher_set_iv_length(VALUE self, VALUE iv_length)
{
int len = NUM2INT(iv_length);
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER))
ossl_raise(eCipherError, "cipher does not support AEAD");
if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, len, NULL))
ossl_raise(eCipherError, "unable to set IV length");
/*
* EVP_CIPHER_CTX_iv_length() returns the default length. So we need to save
* the length somewhere. Luckily currently we aren't using app_data.
*/
EVP_CIPHER_CTX_set_app_data(ctx, (void *)(VALUE)len);
return iv_length;
}</pre>
</div>
</div>
</div>
<div id="method-i-key-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
key = string → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the key is to be derived from a password, you should rely on PBKDF2 functionality provided by <a href="PKCS5.html"><code>OpenSSL::PKCS5</code></a>. To generate a secure random-based key, <a href="Cipher.html#method-i-random_key"><code>Cipher#random_key</code></a> may be used.</p>
<p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p>
<div class="method-source-code" id="key-3D-source">
<pre>static VALUE
ossl_cipher_set_key(VALUE self, VALUE key)
{
EVP_CIPHER_CTX *ctx;
int key_len;
StringValue(key);
GetCipher(self, ctx);
key_len = EVP_CIPHER_CTX_key_length(ctx);
if (RSTRING_LEN(key) != key_len)
ossl_raise(rb_eArgError, "key must be %d bytes", key_len);
if (EVP_CipherInit_ex(ctx, NULL, NULL, (unsigned char *)RSTRING_PTR(key), NULL, -1) != 1)
ossl_raise(eCipherError, NULL);
rb_ivar_set(self, id_key_set, Qtrue);
return key;
}</pre>
</div>
</div>
</div>
<div id="method-i-key_len" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
key_len → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the key length in bytes of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>.</p>
<div class="method-source-code" id="key_len-source">
<pre>static VALUE
ossl_cipher_key_length(VALUE self)
{
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
return INT2NUM(EVP_CIPHER_CTX_key_length(ctx));
}</pre>
</div>
</div>
</div>
<div id="method-i-key_len-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
key_len = integer → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the key length to any value other than the fixed value is an error.</p>
<p>Under normal circumstances you do not need to call this method (and probably shouldn’t).</p>
<p>See EVP_CIPHER_CTX_set_key_length for further information.</p>
<div class="method-source-code" id="key_len-3D-source">
<pre>static VALUE
ossl_cipher_set_key_length(VALUE self, VALUE key_length)
{
int len = NUM2INT(key_length);
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
if (EVP_CIPHER_CTX_set_key_length(ctx, len) != 1)
ossl_raise(eCipherError, NULL);
return key_length;
}</pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
name → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the name of the cipher which may differ slightly from the original name provided.</p>
<div class="method-source-code" id="name-source">
<pre>static VALUE
ossl_cipher_name(VALUE self)
{
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
return rb_str_new2(EVP_CIPHER_name(EVP_CIPHER_CTX_cipher(ctx)));
}</pre>
</div>
</div>
</div>
<div id="method-i-padding-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
padding = integer → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Enables or disables padding. By default encryption operations are padded using standard block padding and the padding is checked and removed when decrypting. If the pad parameter is zero then no padding is performed, the total amount of data encrypted or decrypted must then be a multiple of the block size or an error will occur.</p>
<p>See EVP_CIPHER_CTX_set_padding for further information.</p>
<div class="method-source-code" id="padding-3D-source">
<pre>static VALUE
ossl_cipher_set_padding(VALUE self, VALUE padding)
{
EVP_CIPHER_CTX *ctx;
int pad = NUM2INT(padding);
GetCipher(self, ctx);
if (EVP_CIPHER_CTX_set_padding(ctx, pad) != 1)
ossl_raise(eCipherError, NULL);
return padding;
}</pre>
</div>
</div>
</div>
<div id="method-i-pkcs5_keyivgen" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
pkcs5_keyivgen(pass, salt = nil, iterations = 2048, digest = "MD5") → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generates and sets the key/IV based on a password.</p>
<p><strong>WARNING</strong>: This method is only <a href="PKCS5.html"><code>PKCS5</code></a> v1.5 compliant when using RC2, RC4-40, or DES with MD5 or SHA1. Using anything else (like AES) will generate the key/iv using an <a href="../OpenSSL.html"><code>OpenSSL</code></a> specific method. This method is deprecated and should no longer be used. Use a <a href="PKCS5.html"><code>PKCS5</code></a> v2 key generation method from <a href="PKCS5.html"><code>OpenSSL::PKCS5</code></a> instead.</p>
<h3 id="method-i-pkcs5_keyivgen-label-Parameters">Parameters<span><a href="#method-i-pkcs5_keyivgen-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><em>salt</em> must be an 8 byte string if provided.</p>
</li><li>
<p><em>iterations</em> is an integer with a default of 2048.</p>
</li><li>
<p><em>digest</em> is a <a href="Digest.html"><code>Digest</code></a> object that defaults to ‘MD5’</p>
</li></ul>
<p>A minimum of 1000 iterations is recommended.</p>
<div class="method-source-code" id="pkcs5_keyivgen-source">
<pre>static VALUE
ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self)
{
EVP_CIPHER_CTX *ctx;
const EVP_MD *digest;
VALUE vpass, vsalt, viter, vdigest;
unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH], *salt = NULL;
int iter;
rb_scan_args(argc, argv, "13", &vpass, &vsalt, &viter, &vdigest);
StringValue(vpass);
if(!NIL_P(vsalt)){
StringValue(vsalt);
if(RSTRING_LEN(vsalt) != PKCS5_SALT_LEN)
ossl_raise(eCipherError, "salt must be an 8-octet string");
salt = (unsigned char *)RSTRING_PTR(vsalt);
}
iter = NIL_P(viter) ? 2048 : NUM2INT(viter);
if (iter <= 0)
rb_raise(rb_eArgError, "iterations must be a positive integer");
digest = NIL_P(vdigest) ? EVP_md5() : ossl_evp_get_digestbyname(vdigest);
GetCipher(self, ctx);
EVP_BytesToKey(EVP_CIPHER_CTX_cipher(ctx), digest, salt,
(unsigned char *)RSTRING_PTR(vpass), RSTRING_LENINT(vpass), iter, key, iv);
if (EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, -1) != 1)
ossl_raise(eCipherError, NULL);
OPENSSL_cleanse(key, sizeof key);
OPENSSL_cleanse(iv, sizeof iv);
rb_ivar_set(self, id_key_set, Qtrue);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-random_iv" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
random_iv → iv
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a random IV with <a href="Random.html#method-c-random_bytes"><code>OpenSSL::Random.random_bytes</code></a> and sets it to the cipher, and returns it.</p>
<p>You must call <a href="Cipher.html#method-i-encrypt"><code>encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>decrypt</code></a> before calling this method.</p>
<div class="method-source-code" id="random_iv-source">
<pre><span class="ruby-comment"># File lib/openssl/cipher.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">random_iv</span>
<span class="ruby-identifier">str</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">random_bytes</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">iv_len</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-random_key" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
random_key → key
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a random key with <a href="Random.html#method-c-random_bytes"><code>OpenSSL::Random.random_bytes</code></a> and sets it to the cipher, and returns it.</p>
<p>You must call <a href="Cipher.html#method-i-encrypt"><code>encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>decrypt</code></a> before calling this method.</p>
<div class="method-source-code" id="random_key-source">
<pre><span class="ruby-comment"># File lib/openssl/cipher.rb, line 43</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">random_key</span>
<span class="ruby-identifier">str</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">random_bytes</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">key_len</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reset" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
reset → self
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fully resets the internal state of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>. By using this, the same <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance may be used several times for encryption or decryption tasks.</p>
<p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1).</p>
<div class="method-source-code" id="reset-source">
<pre>static VALUE
ossl_cipher_reset(VALUE self)
{
EVP_CIPHER_CTX *ctx;
GetCipher(self, ctx);
if (EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1) != 1)
ossl_raise(eCipherError, NULL);
return self;
}</pre>
</div>
</div>
</div>
<div id="method-i-update" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
update(data [, buffer]) → string or buffer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Encrypts data in a streaming fashion. Hand consecutive blocks of data to the <a href="Cipher.html#method-i-update"><code>update</code></a> method in order to encrypt it. Returns the encrypted data chunk. When done, the output of <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a> should be additionally added to the result.</p>
<p>If <em>buffer</em> is given, the encryption/decryption result will be written to it. <em>buffer</em> will be resized automatically.</p>
<div class="method-source-code" id="update-source">
<pre>static VALUE
ossl_cipher_update(int argc, VALUE *argv, VALUE self)
{
EVP_CIPHER_CTX *ctx;
unsigned char *in;
long in_len, out_len;
VALUE data, str;
rb_scan_args(argc, argv, "11", &data, &str);
if (!RTEST(rb_attr_get(self, id_key_set)))
ossl_raise(eCipherError, "key not set");
StringValue(data);
in = (unsigned char *)RSTRING_PTR(data);
if ((in_len = RSTRING_LEN(data)) == 0)
ossl_raise(rb_eArgError, "data must not be empty");
GetCipher(self, ctx);
out_len = in_len+EVP_CIPHER_CTX_block_size(ctx);
if (out_len <= 0) {
ossl_raise(rb_eRangeError,
"data too big to make output buffer: %ld bytes", in_len);
}
if (NIL_P(str)) {
str = rb_str_new(0, out_len);
} else {
StringValue(str);
rb_str_resize(str, out_len);
}
if (!ossl_cipher_update_long(ctx, (unsigned char *)RSTRING_PTR(str), &out_len, in, in_len))
ossl_raise(eCipherError, NULL);
assert(out_len < RSTRING_LEN(str));
rb_str_set_len(str, out_len);
return str;
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
