kigit_known_hosts.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KIGIT_KNOWN_HOSTS_H_
#define KIGIT_KNOWN_HOSTS_H_
 
#include <import_export.h>
 
#include <array>
#include <cstdint>
#include <string>
 
#include <wx/string.h>
 
namespace KIGIT
{

enum class KNOWN_HOST_STATE
{
    UNKNOWN,        
    MATCH,          
    MISMATCH,       
    OTHER_KEY_TYPE, 
    REVOKED         
};
 

struct HOST_KEY_FAILURE
{
    KNOWN_HOST_STATE state = KNOWN_HOST_STATE::UNKNOWN;
    wxString         host;
    int              port = 22;
    wxString         keyType;     
    std::string      rawKey;      
    wxString         fingerprint; 
};
 

APIEXPORT std::array<uint8_t, 20> HmacSha1( const std::string& aKey, const std::string& aData );

APIEXPORT KNOWN_HOST_STATE LookupKnownHost( const wxString& aKnownHostsText, const wxString& aHost, int aPort,
                                            const wxString& aKeyType, const std::string& aRawKey );

APIEXPORT wxString FormatKnownHostsLine( const wxString& aHost, int aPort, const wxString& aKeyType,
                                         const wxString& aBase64Key );

APIEXPORT wxString HostKeyType( const std::string& aRawKey );

APIEXPORT wxString HostKeyFingerprint( const std::string& aRawKey );

APIEXPORT wxString KnownHostsPath();

APIEXPORT bool MayOfferTrust( const HOST_KEY_FAILURE& aFailure, bool aRetriedAfterTrust );

APIEXPORT wxString HostKeyRefusalMessage( const HOST_KEY_FAILURE& aFailure );

APIEXPORT wxString Libgit2LegacyHome( int aRevision );

APIEXPORT wxString ReadKnownHosts();

APIEXPORT bool AddKnownHost( const HOST_KEY_FAILURE& aKey );
 
} // namespace KIGIT
 
#endif // KIGIT_KNOWN_HOSTS_H_