mirror of
https://github.com/RetroShare/RetroShare.git
synced 2024-12-29 09:26:18 -05:00
df87fe53b1
Removed antipattern abstraction RsSingleJobThread Rename runloop() method to run() in RsThread Ported few classes ineriting from RsSingleJobThread to RsThread RsThread use std::atomic instead of self implemented strange binary semaphores Removed RsTickingThread::shutdown() use RsThread::askForStop() instead Removed RsTickingThread::fullstop() use RsThread::fullstop() instead Stop properly JSON API server in retroshare-gui Centralize errno traslation to literal in util/rserrno.*
304 lines
12 KiB
C++
304 lines
12 KiB
C++
/*******************************************************************************
|
|
* libretroshare/src/pqi: authgpg.h *
|
|
* *
|
|
* libretroshare: retroshare core library *
|
|
* *
|
|
* Copyright 2008-2009 by Raghu Dev R. *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Lesser General Public License as *
|
|
* published by the Free Software Foundation, either version 3 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public License *
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
*******************************************************************************/
|
|
|
|
/****
|
|
* Here's GPG policy :
|
|
* By default, all pgpg keys imported via a RS user (make friend and accept friend action) are signed at level 0.
|
|
* All signed keys by RS are set to be trusted marginally. You can change it to full or no trust in the friend profile
|
|
* For a key to be marginaly valid, it has to be signed by one fully trusted key, or at least by 3 marginally trusted keys.
|
|
* All keys that have at least marginal validity are designed as valid in RS. They are shown in the RS gui in order to be signed.
|
|
* If there is no validity then the key is not shown.
|
|
*/
|
|
|
|
#ifndef RS_GPG_AUTH_HEADER
|
|
#define RS_GPG_AUTH_HEADER
|
|
|
|
#include "util/rsthreads.h"
|
|
#include "pqi/p3cfgmgr.h"
|
|
#include "pgp/pgphandler.h"
|
|
|
|
#define MAX_GPG_SIGNATURE_SIZE 4096
|
|
|
|
struct RsPeerDetails;
|
|
|
|
/*!
|
|
* gpgcert is the identifier for a person.
|
|
* It is a wrapper class for a OpenPGP certificate.
|
|
*/
|
|
|
|
class AuthGPGOperation
|
|
{
|
|
public:
|
|
explicit AuthGPGOperation(void *userdata)
|
|
{
|
|
m_userdata = userdata;
|
|
}
|
|
virtual ~AuthGPGOperation() {}
|
|
|
|
public:
|
|
void *m_userdata;
|
|
};
|
|
|
|
class AuthGPGOperationLoadOrSave : public AuthGPGOperation
|
|
{
|
|
public:
|
|
AuthGPGOperationLoadOrSave(bool load, const RsPgpId &gpgId, const std::string &gpgCert, void *userdata)
|
|
: AuthGPGOperation(userdata)
|
|
{
|
|
m_load = load;
|
|
if (m_load) {
|
|
m_certGpg = gpgCert;
|
|
m_certGpgId = gpgId;
|
|
} else {
|
|
m_certGpgId = gpgId;
|
|
}
|
|
}
|
|
|
|
public:
|
|
bool m_load;
|
|
RsPgpId m_certGpgId; // set for save & load.
|
|
std::string m_certGpg; // set for load
|
|
};
|
|
|
|
class AuthGPGService
|
|
{
|
|
public:
|
|
AuthGPGService() {}
|
|
~AuthGPGService() {}
|
|
|
|
virtual AuthGPGOperation *getGPGOperation() = 0;
|
|
virtual void setGPGOperation(AuthGPGOperation *operation) = 0;
|
|
};
|
|
|
|
class AuthGPG: public p3Config, public RsTickingThread, public PGPHandler
|
|
{
|
|
public:
|
|
static void init(const std::string& path_to_pubring,
|
|
const std::string& path_to_secring,
|
|
const std::string& path_to_trustdb,
|
|
const std::string& pgp_lock_file);
|
|
|
|
static void exit();
|
|
static AuthGPG *getAuthGPG() { return _instance ; }
|
|
|
|
/**
|
|
* @param ids list of gpg certificate ids (note, not the actual certificates)
|
|
*/
|
|
//virtual bool availableGPGCertificatesWithPrivateKeys(std::list<RsPgpId> &ids);
|
|
|
|
/*********************************************************************************/
|
|
/************************* STAGE 1 ***********************************************/
|
|
/*********************************************************************************/
|
|
/*****
|
|
* STAGE 1: Initialisation.... As we are switching to OpenPGP the init functions
|
|
* will be different. Just move the initialisation functions over....
|
|
*
|
|
* As GPGMe requires external calls to the GPG executable, which could potentially
|
|
* be expensive, We'll want to cache the GPG keys in this class.
|
|
* This should be done at initialisation, and saved in a map.
|
|
* (see storage at the end of the class)
|
|
*
|
|
****/
|
|
virtual bool active();
|
|
|
|
// /* Initialize */
|
|
// virtual bool InitAuth ();
|
|
// virtual bool CloseAuth();
|
|
|
|
/* Init by generating new Own PGP Cert, or selecting existing PGP Cert */
|
|
|
|
virtual int GPGInit(const RsPgpId &ownId);
|
|
virtual bool GeneratePGPCertificate(const std::string& name, const std::string& email, const std::string& passwd, RsPgpId &pgpId, const int keynumbits, std::string &errString);
|
|
|
|
/*********************************************************************************/
|
|
/************************* STAGE 3 ***********************************************/
|
|
/*********************************************************************************/
|
|
/*****
|
|
* STAGE 3: These are some of the most commonly used functions in Retroshare.
|
|
*
|
|
* More commonly used functions.
|
|
*
|
|
* provide access to details in cache list.
|
|
*
|
|
****/
|
|
virtual std::string getGPGName(const RsPgpId &pgp_id,bool *success = NULL);
|
|
virtual std::string getGPGEmail(const RsPgpId &pgp_id,bool *success = NULL);
|
|
|
|
/* PGP web of trust management */
|
|
virtual const RsPgpId& getGPGOwnId();
|
|
virtual std::string getGPGOwnName();
|
|
|
|
//virtual std::string getGPGOwnEmail();
|
|
virtual bool isKeySupported(const RsPgpId &id) const ;
|
|
virtual bool haveSecretKey(const RsPgpId &id) const ;
|
|
virtual bool getGPGDetails(const RsPgpId& id, RsPeerDetails &d);
|
|
virtual bool getGPGAllList(std::list<RsPgpId> &ids);
|
|
virtual bool getGPGValidList(std::list<RsPgpId> &ids);
|
|
virtual bool getGPGAcceptedList(std::list<RsPgpId> &ids);
|
|
virtual bool getGPGSignedList(std::list<RsPgpId> &ids);
|
|
virtual bool importProfile(const std::string& filename,RsPgpId& gpg_id,std::string& import_error) ;
|
|
virtual bool importProfileFromString(const std::string& data,RsPgpId& gpg_id,std::string& import_error) ;
|
|
virtual bool exportProfile(const std::string& filename,const RsPgpId& gpg_id) ;
|
|
virtual bool exportIdentityToString(
|
|
std::string& data, const RsPgpId& pgpId, bool includeSignatures,
|
|
std::string& errorMsg );
|
|
|
|
virtual bool removeKeysFromPGPKeyring(const std::set<RsPgpId> &pgp_ids,std::string& backup_file,uint32_t& error_code) ;
|
|
|
|
/*********************************************************************************/
|
|
/************************* STAGE 4 ***********************************************/
|
|
/*********************************************************************************/
|
|
/*****
|
|
* STAGE 4: Loading and Saving Certificates. (Strings and Files)
|
|
*
|
|
****/
|
|
virtual bool LoadCertificateFromString(const std::string &pem, RsPgpId& gpg_id,std::string& error_string);
|
|
virtual bool LoadPGPKeyFromBinaryData(const unsigned char *data,uint32_t data_len, RsPgpId& gpg_id,std::string& error_string);
|
|
virtual std::string SaveCertificateToString(const RsPgpId &id,bool include_signatures) ;
|
|
|
|
// Cached certificates.
|
|
//bool getCachedGPGCertificate(const RsPgpId &id, std::string &certificate);
|
|
|
|
/*********************************************************************************/
|
|
/************************* STAGE 6 ***********************************************/
|
|
/*********************************************************************************/
|
|
/*****
|
|
* STAGE 6: Authentication, Trust and Signing.
|
|
*
|
|
* This is some of the harder functions, but they should have been
|
|
* done in gpgroot already.
|
|
*
|
|
****/
|
|
virtual bool AllowConnection(const RsPgpId &gpg_id, bool accept);
|
|
|
|
virtual bool SignCertificateLevel0(const RsPgpId &id);
|
|
virtual bool RevokeCertificate(const RsPgpId &id); /* Particularly hard - leave for later */
|
|
|
|
virtual bool TrustCertificate(const RsPgpId& id, int trustlvl); //trustlvl is 2 for none, 3 for marginal and 4 for full trust
|
|
|
|
/*********************************************************************************/
|
|
/************************* STAGE 7 ***********************************************/
|
|
/*********************************************************************************/
|
|
/*****
|
|
* STAGE 7: Signing Data.
|
|
*
|
|
* There should also be Encryption Functions... (do later).
|
|
*
|
|
****/
|
|
virtual bool SignDataBin(const void *data, const uint32_t len, unsigned char *sign, unsigned int *signlen, std::string reason = "");
|
|
virtual bool VerifySignBin(const void*, uint32_t, unsigned char*, unsigned int, const PGPFingerprintType& withfingerprint);
|
|
virtual bool parseSignature(const void *sig, unsigned int siglen, RsPgpId& issuer_id);
|
|
|
|
virtual bool encryptDataBin(const RsPgpId& pgp_id,const void *data, const uint32_t len, unsigned char *encr, unsigned int *encrlen);
|
|
virtual bool decryptDataBin(const void *data, const uint32_t len, unsigned char *decr, unsigned int *decrlen);
|
|
|
|
virtual bool decryptTextFromFile( std::string& text,const std::string& filename);
|
|
virtual bool encryptTextToFile (const std::string& text,const std::string& filename);
|
|
|
|
// virtual bool decryptTextFromString( std::string& encrypted_text,std::string& clear_string);
|
|
// virtual bool encryptTextToString (const std::string& pgp_id,const std::string& clear_text,std::string& encrypted_string);
|
|
|
|
bool getGPGFilteredList(std::list<RsPgpId>& list,bool (*filter)(const PGPCertificateInfo&) = NULL) ;
|
|
|
|
//END of PGP public functions
|
|
|
|
/* GPG service */
|
|
virtual bool addService(AuthGPGService *service) ;
|
|
|
|
// This is for debug purpose only. Don't use it !!
|
|
static void setAuthGPG_debug(AuthGPG *auth_gpg) { _instance = auth_gpg ; }
|
|
|
|
protected:
|
|
AuthGPG(const std::string& path_to_pubring, const std::string& path_to_secring,const std::string& path_to_trustdb,const std::string& pgp_lock_file);
|
|
virtual ~AuthGPG();
|
|
|
|
/*****************************************************************/
|
|
/*********************** p3config ******************************/
|
|
/* Key Functions to be overloaded for Full Configuration */
|
|
virtual RsSerialiser *setupSerialiser();
|
|
virtual bool saveList(bool &cleanup, std::list<RsItem *>&);
|
|
virtual bool loadList(std::list<RsItem *>& load);
|
|
/*****************************************************************/
|
|
|
|
private:
|
|
// Gets the certificate pointer and returns NULL if the string is invalid, or the
|
|
// cert was not found.
|
|
//
|
|
const PGPCertificateInfo *getCertInfoFromStdString(const std::string& ) const;
|
|
|
|
/* SKTAN */
|
|
//void showData(gpgme_data_t dh);
|
|
//void createDummyFriends(void); //NYI
|
|
|
|
/* Internal functions */
|
|
bool DoOwnSignature(const void *, unsigned int, void *, unsigned int *, std::string reason);
|
|
bool VerifySignature(const void *data, int datalen, const void *sig, unsigned int siglen, const PGPFingerprintType& withfingerprint);
|
|
|
|
/* Sign/Trust stuff */
|
|
int privateSignCertificate(const RsPgpId &id);
|
|
int privateRevokeCertificate(const RsPgpId &id); /* revoke the signature on Certificate */
|
|
int privateTrustCertificate(const RsPgpId& id, int trustlvl);
|
|
|
|
// store all keys in map mKeyList to avoid calling gpgme exe repeatedly
|
|
//bool storeAllKeys();
|
|
//bool storeAllKeys_tick();
|
|
|
|
// Not used anymore
|
|
// bool updateTrustAllKeys_locked();
|
|
|
|
/* GPG service */
|
|
void processServices();
|
|
|
|
bool printAllKeys_locked();
|
|
bool printOwnKeys_locked();
|
|
|
|
void threadTick() override; /// @see RsTickingThread
|
|
|
|
private:
|
|
|
|
static AuthGPG *instance_gpg; // pointeur vers le singleton
|
|
|
|
RsMutex gpgMtxService;
|
|
RsMutex gpgMtxEngine;
|
|
|
|
/* Below is protected via the mutex */
|
|
|
|
// gpgme_engine_info_t INFO;
|
|
// gpgme_ctx_t CTX;
|
|
|
|
RsMutex gpgMtxData;
|
|
/* Below is protected via the mutex */
|
|
|
|
rstime_t mStoreKeyTime;
|
|
|
|
RsPgpId mOwnGpgId;
|
|
bool gpgKeySelected;
|
|
bool _force_sync_database ;
|
|
uint32_t mCount ;
|
|
|
|
std::list<AuthGPGService*> services ;
|
|
|
|
static AuthGPG *_instance ;
|
|
};
|
|
|
|
#endif
|