~ubuntu-branches/ubuntu/wily/qca2/wily-proposed

« back to all changes in this revision

Viewing changes to include/QtCrypto/qca_securemessage.h

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2007-10-27 18:51:54 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20071027185154-4ir9ys3h2q9fofrw
Tags: 2.0.0-2
Upload to unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
47
47
   \class SecureMessageKey qca_securemessage.h QtCrypto
48
48
 
49
49
   Key for SecureMessage system
 
50
 
 
51
   \ingroup UserAPI
50
52
*/
51
53
class QCA_EXPORT SecureMessageKey
52
54
{
128
130
 
129
131
        /**
130
132
           Set the public key part of this X.509 key.
 
133
 
 
134
           \param c the Certificate chain containing the public keys
131
135
        */
132
136
        void setX509CertificateChain(const CertificateChain &c);
133
137
 
134
138
        /**
135
139
           Set the private key part of this X.509 key.
 
140
 
 
141
           \param k the private key
136
142
        */
137
143
        void setX509PrivateKey(const PrivateKey &k);
138
144
 
139
145
        /**
140
146
           Set the public and private part of this X.509 key with KeyBundle.
 
147
 
 
148
           \param kb the public and private key bundle
141
149
        */
142
150
        void setX509KeyBundle(const KeyBundle &kb);
143
151
 
169
177
   \class SecureMessageSignature qca_securemessage.h QtCrypto
170
178
 
171
179
   SecureMessage signature
 
180
 
 
181
   \ingroup UserAPI
172
182
*/
173
183
class QCA_EXPORT SecureMessageSignature
174
184
{
185
195
        };
186
196
 
187
197
        /**
188
 
           Create an empty signature check object
 
198
           Create an empty signature check object.
 
199
 
 
200
           User applications don't normally need to create signature checks. You normally
 
201
           get the object back as a result of a SecureMessage operation.
189
202
        */
190
203
        SecureMessageSignature();
191
204
 
192
205
        /**
193
206
           Create a signature check object
 
207
 
 
208
           User applications don't normally need to create signature checks. You normally
 
209
           get the object back as a result of a SecureMessage operation.
 
210
 
 
211
           \param r the result of the check
 
212
           \param v the Validity of the key validation check
 
213
           \param key the key associated with the signature
 
214
           \param ts the timestamp associated with the signature
194
215
        */
195
216
        SecureMessageSignature(IdentityResult r, Validity v, const SecureMessageKey &key, const QDateTime &ts);
196
217
 
240
261
*/
241
262
typedef QList<SecureMessageSignature> SecureMessageSignatureList;
242
263
 
 
264
 
243
265
/**
244
266
   \class SecureMessage qca_securemessage.h QtCrypto
245
267
 
291
313
   \sa SecureMessageSignature
292
314
   \sa OpenPGP
293
315
   \sa CMS
 
316
 
 
317
   \ingroup UserAPI
294
318
*/
295
319
class QCA_EXPORT SecureMessage : public QObject, public Algorithm
296
320
{
434
458
           bundle the signer, greatly simplifying key management.
435
459
 
436
460
           This behavior is enabled by default.
 
461
 
 
462
           \param b whether to bundle (if true) or not (false)
437
463
        */
438
464
        void setBundleSignerEnabled(bool b);
439
465
 
444
470
           used are decided by the provider.
445
471
 
446
472
           This behavior is enabled by default.
 
473
 
 
474
           \param b whether to embed extra attribues (if true) or not (false)
447
475
        */
448
476
        void setSMIMEAttributesEnabled(bool b);
449
477
 
459
487
        /**
460
488
           Set the recipient for an encrypted message
461
489
 
 
490
           \param key the recipient's key
 
491
 
462
492
           \sa setRecipients
463
493
        */
464
494
        void setRecipient(const SecureMessageKey &key);
468
498
 
469
499
           For a list with one item, this has the same effect as setRecipient.
470
500
 
 
501
           \param keys the recipients' key
 
502
 
471
503
           \sa setRecipient
472
504
        */
473
505
        void setRecipients(const SecureMessageKeyList &keys);
478
510
           This is used for both creating signed messages as well as for
479
511
           verifying CMS messages that have no signer bundled.
480
512
 
 
513
           \param key the key associated with the signer
 
514
 
481
515
           \sa setSigners
482
516
        */
483
517
        void setSigner(const SecureMessageKey &key);
490
524
 
491
525
           For a list with one item, this has the same effect as setSigner.
492
526
 
 
527
           \param keys the key associated with the signer
 
528
 
493
529
           \sa setSigner
494
530
        */
495
531
        void setSigners(const SecureMessageKeyList &keys);
731
767
        /**
732
768
           This signal is emitted when data has been accepted
733
769
           by the message processor.
 
770
 
 
771
           \param bytes the number of bytes written
734
772
        */
735
773
        void bytesWritten(int bytes);
736
774
 
755
793
 
756
794
   \sa SecureMessage
757
795
   \sa SecureMessageKey
 
796
 
 
797
   \ingroup UserAPI
758
798
*/
759
799
class QCA_EXPORT SecureMessageSystem : public QObject, public Algorithm
760
800
{
789
829
 
790
830
   \sa SecureMessage
791
831
   \sa SecureMessageKey
 
832
 
 
833
   \ingroup UserAPI
 
834
 
792
835
*/
793
836
class QCA_EXPORT OpenPGP : public SecureMessageSystem
794
837
{
832
875
 
833
876
   \sa SecureMessage
834
877
   \sa SecureMessageKey
 
878
 
 
879
   \ingroup UserAPI
 
880
 
835
881
*/
836
882
class QCA_EXPORT CMS : public SecureMessageSystem
837
883
{