KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kigit_ssh_keys.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 3
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#ifndef KIGIT_SSH_KEYS_H_
21#define KIGIT_SSH_KEYS_H_
22
23#include <import_export.h>
24
25#include <vector>
26
27#include <wx/string.h>
28
29namespace KIGIT
30{
31
39APIEXPORT std::vector<wxString> ParseSSHConfigIdentityFiles( const wxString& aConfigText, const wxString& aHost,
40 const wxString& aHomeDir );
41
49APIEXPORT std::vector<wxString> DefaultSSHKeyCandidates( const wxString& aHomeDir, const wxString& aHost );
50
55APIEXPORT bool IsSameSSHKey( const wxString& aKey, const wxString& aOther );
56
61APIEXPORT wxString HomeDir();
62
67APIEXPORT bool IsOfferableSSHKey( const wxString& aKey );
68
69} // namespace KIGIT
70
71#endif // KIGIT_SSH_KEYS_H_
#define APIEXPORT
Macros which export functions from a DLL/DSO.
APIEXPORT bool IsOfferableSSHKey(const wxString &aKey)
Whether aKey can be offered to a server.
APIEXPORT std::vector< wxString > ParseSSHConfigIdentityFiles(const wxString &aConfigText, const wxString &aHost, const wxString &aHomeDir)
The IdentityFile entries an ssh config gives aHost, in file order.
APIEXPORT wxString HomeDir()
The user's home folder, where ssh looks for its config and default keys.
APIEXPORT bool IsSameSSHKey(const wxString &aKey, const wxString &aOther)
Whether two key paths name the same file.
APIEXPORT std::vector< wxString > DefaultSSHKeyCandidates(const wxString &aHomeDir, const wxString &aHost)
Private keys to offer aHost, best first.