mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-02-08 02:55:39 -05:00
204 lines
8.1 KiB
C++
204 lines
8.1 KiB
C++
/*******************************************************************************
|
|
* libretroshare/src/retroshare: rsinit.h *
|
|
* *
|
|
* libretroshare: retroshare core library *
|
|
* *
|
|
* Copyright 2004-2006 by Robert Fernie <retroshare@lunamutt.com> *
|
|
* *
|
|
* 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/>. *
|
|
* *
|
|
*******************************************************************************/
|
|
#ifndef RETROSHARE_INIT_INTERFACE_H
|
|
#define RETROSHARE_INIT_INTERFACE_H
|
|
|
|
// Initialize ok, result >= 0
|
|
#define RS_INIT_OK 0 // Initialize ok
|
|
#define RS_INIT_HAVE_ACCOUNT 1 // Initialize ok, have account
|
|
// Initialize failed, result < 0
|
|
#define RS_INIT_AUTH_FAILED -1 // AuthGPG::InitAuth failed
|
|
#define RS_INIT_BASE_DIR_ERROR -2 // AuthGPG::InitAuth failed
|
|
#define RS_INIT_NO_KEYRING -3 // Keyring is empty. Need to import it.
|
|
|
|
|
|
/****
|
|
* #define RS_USE_PGPSSL 1
|
|
***/
|
|
|
|
#define RS_USE_PGPSSL 1
|
|
|
|
#include <stdint.h>
|
|
#include <list>
|
|
#include <map>
|
|
#include <vector>
|
|
#include <retroshare/rstypes.h>
|
|
|
|
/*!
|
|
* Initialisation Class (not publicly disclosed to RsIFace)
|
|
*/
|
|
class RsInit
|
|
{
|
|
public:
|
|
/* reorganised RsInit system */
|
|
|
|
/*!
|
|
* PreLogin
|
|
* Call before init retroshare, initialises rsinitconfig's public attributes
|
|
*/
|
|
static void InitRsConfig() ;
|
|
|
|
/*!
|
|
* Should be called to load up ssl cert and private key, and intialises gpg
|
|
* this must be called before accessing rsserver (e.g. ::startupretroshare)
|
|
* @param argc passed from executable
|
|
* @param argv commandline arguments passed to executable
|
|
* @param strictCheck set to true if you want rs to continue executing if invalid argument passed and vice versa
|
|
* @return RS_INIT_...
|
|
*/
|
|
static int InitRetroShare(int argc, char **argv, bool strictCheck=true);
|
|
|
|
static bool isPortable();
|
|
static bool isWindowsXP();
|
|
static bool collectEntropy(uint32_t bytes) ;
|
|
|
|
/*!
|
|
* Setup Hidden Location;
|
|
*/
|
|
static void SetHiddenLocation(const std::string& hiddenaddress, uint16_t port, bool useBob);
|
|
|
|
static bool LoadPassword(const std::string& passwd) ;
|
|
|
|
/*!
|
|
|
|
|
|
* Final Certificate load. This can be called if:
|
|
* a) InitRetroshare() returns RS_INIT_HAVE_ACCOUNT -> autoLoad/password Set.
|
|
* b) or LoadPassword()
|
|
*
|
|
* This uses the preferredId from RsAccounts.
|
|
* This wrapper also locks the profile before finalising the login
|
|
*/
|
|
static int LockAndLoadCertificates(bool autoLoginNT, std::string& lockFilePath);
|
|
|
|
/*!
|
|
* Post Login Options
|
|
*/
|
|
|
|
static bool getStartMinimised();
|
|
|
|
static int getSslPwdLen();
|
|
static bool getAutoLogin();
|
|
static void setAutoLogin(bool autoLogin);
|
|
static bool RsClearAutoLogin() ;
|
|
|
|
private:
|
|
|
|
#if 0
|
|
/* Auto Login */
|
|
static bool RsStoreAutoLogin() ;
|
|
static bool RsTryAutoLogin() ;
|
|
#endif
|
|
|
|
// THESE CAN BE REMOVED FROM THE CLASS TOO.
|
|
/* Lock/unlock profile directory */
|
|
static int LockConfigDirectory(const std::string& accountDir, std::string& lockFilePath);
|
|
static void UnlockConfigDirectory();
|
|
|
|
/* The true LoadCertificates() method */
|
|
static int LoadCertificates(bool autoLoginNT) ;
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Seperate static Class for dealing with Accounts */
|
|
|
|
class RsAccountsDetail ;
|
|
|
|
class RsAccounts
|
|
{
|
|
public:
|
|
// Should be called once before everything else.
|
|
|
|
static bool init(const std::string &opt_base_dir, int& error_code);
|
|
|
|
/**
|
|
* @brief ConfigDirectory (normally ~/.retroshare) you can call this method
|
|
* even before initialisation (you can't with some other methods)
|
|
*
|
|
* On linux: ~/.retroshare/
|
|
*
|
|
* @see RsAccountsDetail::PathBaseDirectory()
|
|
*/
|
|
static std::string ConfigDirectory();
|
|
|
|
/**
|
|
* @brief DataDirectory
|
|
* you can call this method even before initialisation (you can't with some other methods)
|
|
* @param check if set to true and directory does not exist, return empty string
|
|
* @return path where global platform independent files are stored, like bdboot.txt or webinterface files
|
|
*/
|
|
static std::string systemDataDirectory(bool check = true);
|
|
static std::string PGPDirectory();
|
|
|
|
// PGP Accounts.
|
|
static int GetPGPLogins(std::list<RsPgpId> &pgpIds);
|
|
static int GetPGPLoginDetails(const RsPgpId& id, std::string &name, std::string &email);
|
|
static bool GeneratePGPCertificate(const std::string&, const std::string& email, const std::string& passwd, RsPgpId &pgpId, const int keynumbits, std::string &errString);
|
|
|
|
// PGP Support Functions.
|
|
static bool ExportIdentity(const std::string& fname,const RsPgpId& pgp_id) ;
|
|
static bool ImportIdentity(const std::string& fname,RsPgpId& imported_pgp_id,std::string& import_error) ;
|
|
static bool ImportIdentityFromString(const std::string& data,RsPgpId& imported_pgp_id,std::string& import_error) ;
|
|
static void GetUnsupportedKeys(std::map<std::string,std::vector<std::string> > &unsupported_keys);
|
|
static bool CopyGnuPGKeyrings() ;
|
|
|
|
// Rs Accounts
|
|
static bool SelectAccount(const RsPeerId& id);
|
|
static bool GetPreferredAccountId(RsPeerId &id);
|
|
static bool GetAccountIds(std::list<RsPeerId> &ids);
|
|
|
|
static bool GetAccountDetails(const RsPeerId &id, RsPgpId &gpgId, std::string &gpgName, std::string &gpgEmail, std::string &location);
|
|
|
|
static bool createNewAccount(const RsPgpId& pgp_id, const std::string& org, const std::string& loc, const std::string& country, bool ishiddenloc,bool is_auto_tor, const std::string& passwd, RsPeerId &sslId, std::string &errString);
|
|
|
|
static void storeSelectedAccount() ;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// All methods bellow can only be called ones SelectAccount() as been called. //
|
|
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static bool getCurrentAccountOptions(bool& is_hidden,bool& is_tor_auto,bool& is_first_time) ;
|
|
|
|
static bool checkCreateAccountDirectory(); // Generate the hierarchy of directories below ~/.retroshare/[SSL dir]/
|
|
static bool isHiddenNode() ; // true if the running node is a hidden node. Used to choose which services to start.
|
|
static bool isTorAuto() ; // true if the running node is a hidden node using automated Tor management
|
|
|
|
static std::string AccountDirectory(); // linux: ~/.retroshare/[SSL dir]/
|
|
static std::string AccountKeysDirectory(); // linux: ~/.retroshare/[SSL dir]/keys/
|
|
static std::string AccountPathCertFile(); // linux: ~/.retroshare/[SSL dir]/keys/user_cert.pem
|
|
static std::string AccountPathKeyFile(); // linux: ~/.retroshare/[SSL dir]/keys/user_pk.pem
|
|
static std::string AccountLocationName();
|
|
|
|
static bool lockPreferredAccount() ; // are these methods any useful??
|
|
static void unlockPreferredAccount() ;
|
|
|
|
private:
|
|
static RsAccountsDetail *rsAccounts ;
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif
|