/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsPKCS12Blob_h

#define nsPKCS12Blob_h

#include "nsCOMPtr.h"

#include "nsIMutableArray.h"

#include "nsString.h"

#include "p12.h"

#include "seccomon.h"

class nsIFile;

class nsIX509Cert;

//

// nsPKCS12Blob

//

// Class for importing/exporting PKCS#12 blobs

//

class nsPKCS12Blob {

 public:

  nsPKCS12Blob();

  virtual ~nsPKCS12Blob() {}

  // PKCS#12 Import

  nsresult ImportFromFile(nsIFile *file);

  // PKCS#12 Export

  nsresult ExportToFile(nsIFile *file, nsIX509Cert **certs, int numCerts);

 private:

  nsCOMPtr<nsIMutableArray> mCertArray;

  nsCOMPtr<nsIInterfaceRequestor> mUIContext;

  // local helper functions

  nsresult getPKCS12FilePassword(SECItem *);

  nsresult newPKCS12FilePassword(SECItem *);

  nsresult inputToDecoder(SEC_PKCS12DecoderContext *, nsIFile *);

  nsresult unicodeToItem(const nsString &uni, SECItem *item);

  void handleError(int myerr = 0);

  // RetryReason and ImportMode are used when importing a PKCS12 file.

  // There are two reasons that cause us to retry:

  // - When the password entered by the user is incorrect.

  //   The user will be prompted to try again.

  // - When the user entered a zero length password.

  //   An empty password should be represented as an empty

  //   string (a SECItem that contains a single terminating

  //   null UTF16 character), but some applications use a

  //   zero length SECItem.

  //   We try both variations, zero length item and empty string,

  //   without giving a user prompt when trying the different empty password

  //   flavors.

  enum RetryReason {

    rr_do_not_retry,

    rr_bad_password,

    rr_auto_retry_empty_password_flavors

  };

  enum ImportMode { im_standard_prompt, im_try_zero_length_secitem };

  nsresult ImportFromFileHelper(nsIFile *file, ImportMode aImportMode,

                                RetryReason &aWantRetry);

  // NSPR file I/O for export file

  PRFileDesc *mTmpFile;

  static SECItem *nickname_collision(SECItem *, PRBool *, void *);

  static void write_export_file(void *arg, const char *buf, unsigned long len);

};

#endif  // nsPKCS12Blob_h