KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kigit_ssh_keys.h File Reference
#include <import_export.h>
#include <string>
#include <vector>
#include <wx/string.h>

Go to the source code of this file.

Namespaces

namespace  KIGIT
 

Functions

APIEXPORT std::vector< wxString > KIGIT::ParseSSHConfigIdentityFiles (const wxString &aConfigText, const wxString &aHost, const wxString &aHomeDir)
 The IdentityFile entries an ssh config gives aHost, in file order.
 
APIEXPORT std::vector< wxString > KIGIT::ParseSSHCommandIdentityFiles (const wxString &aCommand, const wxString &aHomeDir)
 The -i key files in an ssh command line such as git's core.sshCommand, in order.
 
APIEXPORT std::vector< wxString > KIGIT::DefaultSSHKeyCandidates (const wxString &aHomeDir, const wxString &aHost, const wxString &aSSHCommand=wxEmptyString)
 Private keys to offer aHost, best first.
 
APIEXPORT bool KIGIT::IsSameSSHKey (const wxString &aKey, const wxString &aOther)
 Whether two key paths name the same file.
 
APIEXPORT std::vector< wxString > KIGIT::HomeDirCandidates ()
 The folders that may be the user's home, most likely first.
 
APIEXPORT wxString KIGIT::HomeDir ()
 The user's home folder, where ssh looks for its config and default keys: the first candidate with a .ssh folder, else the first candidate.
 
APIEXPORT wxString KIGIT::SSHKeyFolder ()
 The folder ssh keeps keys in, for a file picker to open at. Empty when the home folder is unknown.
 
APIEXPORT bool KIGIT::IsOfferableSSHKey (const wxString &aKey)
 Whether aKey can be offered to a server.
 
APIEXPORT wxString KIGIT::PublicKeyPath (const wxString &aKey)
 The public key file to offer with aKey.
 
APIEXPORT wxString KIGIT::EnsurePublicKeyFile (const wxString &aKey)
 PublicKeyPath for aKey, first writing a public key file to KiCad's cache when the key has no .pub beside it.
 
APIEXPORT void KIGIT::SetDerivedPublicKeyFolder (const wxString &aDir)
 Keep public key files written by EnsurePublicKeyFile in aDir.
 
APIEXPORT wxString KIGIT::PrivateKeyPath (const wxString &aPicked)
 The private key for a path picked in a file dialog, which may be the key's .pub file.
 
APIEXPORT std::string KIGIT::PublicKeyBlob (const wxString &aKey)
 The public key blob from aKey's public key file, as the server sees it, or empty when it cannot be read.
 
APIEXPORT wxString KIGIT::RememberedSSHKey (const wxString &aRemote)
 The key that last connected to aRemote, or empty.
 
APIEXPORT void KIGIT::RememberSSHKey (const wxString &aRemote, const wxString &aKey)
 Remember aKey as the key that connected to aRemote. Safe to call from any thread.
 
APIEXPORT void KIGIT::SetRememberedSSHKeyStore (const wxString &aPath)
 Keep remembered keys in aPath.