You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kmymoney/libkgpgfile/kgpgfile.h

188 lines
6.2 KiB

/***************************************************************************
kgpgfile.h
-------------------
begin : Fri Jan 23 2004
copyright : (C) 2004,2005 by Thomas Baumgart
email : thb@net-bembel.de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef KGPGFILE_H
#define KGPGFILE_H
#include <tqfile.h>
#include <tqobject.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include <kdemacros.h>
/**
* @author Thomas Baumgart
*/
class KShellProcess;
class TDEProcess;
/**
* A class for reading and writing data to/from an
* encrypted e.g. file.
*
* This class presents a TQFile based object to the application
* but reads/writes data from/to the file through an instance of GPG.
*
* @code
*
* +------------------+ write +-----------+ stdin +-------+ +--------+
* | |--------->|\ |---------->| |---->| |
* | Application code | read | TQFile | stdout | GPG | | File |
* | |<---------|/ |<----------| |<----| |
* +------------------+ | KGPGFile | +-------+ +--------+
* | control| |
* +-------------->| |
* +-----------+
* @endcode
*
* The @p write interface contains methods as writeBlock() and putch(), the @p read
* interface the methods readBlock(), getch() and ungetch(). The @p control interface
* special methods only available with KGPGFile e.g. addRecipient(), keyAvailable() and
* GPGAvailable(). Other, more general methods such as open(), close() and flush() are
* not shown in the above picture.
*/
class TDE_EXPORT KGPGFile : public TQObject, public TQFile
{
TQ_OBJECT
public:
KGPGFile(const TQString& fname = "",
const TQString& homedir = "~/.gnupg",
const TQString& options = "");
~KGPGFile();
virtual bool open(int mode);
virtual void close(void);
virtual void flush(void);
virtual Offset size(void) const { return 0; };
virtual TQ_LONG readBlock(char *data, TQ_ULONG maxlen);
virtual TQ_LONG writeBlock(const char *data, TQ_ULONG maxlen);
virtual TQByteArray readAll(void);
virtual int getch(void);
virtual int putch(int c);
virtual int ungetch(int c);
/**
* Adds a recipient for whom the file should be encrypted.
* At least one recipient must be specified using this
* method before the file can be written to. @p recipient
* must contain a valid name as defined by GPG. See the
* GPG documentation for more information.
*
* @param recipient recipients identification (e.g. e-mail address)
*/
void addRecipient(const TQCString& recipient);
/**
* sets the name of the file to @p fn. This method must be
* called prior to open().
*/
void setName(const TQString& fn);
void setComment(const TQString& txt);
const TQCString errmsg(void) const { return m_errmsg; };
int exitStatus(void) const { return m_exitStatus; };
/**
* Checks whether GPG is available or not
*
* @retval true GPG can be started and returns a version number
* @retval false GPG is not available
*/
static bool GPGAvailable(void);
/**
* Checks whether a key for a given user-id @p name exists.
*
* @param name the user-id to be checked. @p name can be
* any reference understood by GPG (e.g. an e-mail
* address or a key-id)
* @retval true key for user-id @p name was found
* @retval false key for user-id @p not available
*/
static bool keyAvailable(const TQString& name);
/**
* This function returns a list of the secret keys contained
* in the keyring. Each list item is devided into two fields
* separated by a colon (':'). The first field contains the
* key id, the second field the name. The list may contain
* multiple entries with the same key-id and different names.
*
* Example of an entry in the list:
*
* "9C59DB40B75DD3BA:Thomas Baumgart <ipwizard@users.sourceforge.net>"
*/
static void secretKeyList(TQStringList& list);
/**
* This function returns a list of the public keys contained
* in the keyring. Each list item is devided into two fields
* separated by a colon (':'). The first field contains the
* key id, the second field the name. The list may contain
* multiple entries with the same key-id and different names.
*
* Example of an entry in the list:
*
* "9C59DB40B75DD3BA:Thomas Baumgart <ipwizard@users.sourceforge.net>"
*/
static void publicKeyList(TQStringList& list, const TQString& pattern = TQString());
#ifdef KMM_DEBUG
void dumpUngetBuffer(void);
void dumpBuffer(char *s, int len) const;
#endif
protected slots:
void slotGPGExited(TDEProcess *);
void slotDataFromGPG(TDEProcess *, char *buf, int len);
void slotErrorFromGPG(TDEProcess *, char *buf, int len);
void slotSendDataToGPG(TDEProcess *);
private:
void init(void);
bool startProcess(const TQStringList& args);
TQ_LONG _writeBlock(const char *data, TQ_ULONG maxlen);
bool open(int mode, const TQString&, bool skipPasswd);
private:
TQString m_fn;
TQString m_pubring;
TQString m_secring;
TQString m_options;
TQString m_comment;
TQString m_homedir;
KShellProcess* m_process;
TQValueList<TQCString> m_recipient;
TQCString m_ungetchBuffer;
TQCString m_errmsg;
int m_exitStatus;
TQ_LONG m_readRemain;
char* m_ptrRemain;
bool m_needExitLoop;
};
#endif