ssh_known_hosts.h

/*
 * ssh_known_hosts.h
 *
 * Mocana Initialization Header
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */


/*------------------------------------------------------------------*/

#ifndef __SSH_KNOWN_HOST_HEADER__
#define __SSH_KNOWN_HOST_HEADER__

#ifdef __cplusplus
extern "C" {
#endif


#ifdef __ENABLE_MOCANA_SSH_KNOWN_HOSTS__

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_addKnownHostsEntry(ubyte** ppBuffer, ubyte4* bufferLen, ubyte * hostName, ubyte * pKey, sbyte4 pKeyLen, ubyte4 * pRetVal);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_checkHostEntryExists(ubyte* pBuffer, ubyte4 bufferLen, ubyte * hostName, ubyte4* pIndex, ubyte4 * pRetVal);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_getEntries(sbyte4 *pEntries);

/*
@brief      Read a known-hosts file and store it in a given known-hosts buffer.

@details    This function reads a known-hosts file and stores its contents in
            a given known-hosts buffer. There is no validity checking on the
            file's contents; they are simply stored in the buffer.

@note       To avoid memory leaks, be sure to make a subsequent call to
            MOCANA_freeReadFile().

@ingroup    func_ssh_server_known_hosts

@since 5.4
@version 5.4 and later

@flags
To enable this function, the following flags must be defined in moptions.h:
+ \c \__ENABLE_SSH_KNOWN_HOSTS__
+ \c \__ENABLE_MOCANA_IPV6__

@inc_file ssh_known_hosts.h

@param filename     Name of file to read.
@param ppBuffer     Pointer to a buffer in which to store the file's contents.
@param pBufferLen   On return, number of bytes stored in the buffer, \p ppBuffer.

@return     \c OK (0) if successful; otherwise a negative number error code
            definition from merrors.h. To retrieve a string containing an 
            English text error identifier corresponding to the function's 
            returned error status, use the \c DISPLAY_ERROR macro.

@remark     This is a convenience function provided for your application's use;
            it is not used by Mocana SoT Platform code.

@funcdoc    ssh_known_hosts.c
*/
MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_readFile(sbyte* filename, ubyte** ppBuffer, ubyte4* pBufferLen);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_removeKnownHostsEntry(ubyte** ppBuffer, ubyte4* pBufferLen, ubyte * hostName, ubyte4 *passed_index, ubyte4* pRetVal);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_retrieveKeyForKnownHostsEntry(ubyte* pBuffer, ubyte4 bufferLen, ubyte * hostName, ubyte ** ppKey, ubyte4 * pKeyLen, ubyte4 * pRetVal);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_updateEntries(ubyte * pBuffer, ubyte4 bufferLen);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_updateKnownHostsEntry(ubyte** ppBuffer, ubyte4* pBufferLen, ubyte * hostName, ubyte * pKey, sbyte4 pKeyLen, ubyte4 * pRetVal);

MOC_EXTERN MSTATUS SSH_KNOWN_HOSTS_verifyKnownHostKeyEntry(ubyte* pBuffer, ubyte4 bufferLen, ubyte* hostName, ubyte * pKey, sbyte4 pKeyLen, ubyte4 * pRetVal);
#endif


#ifdef __cplusplus
}
#endif

#endif /* __SSH_KNOWN_HOST_HEADER__ */