framework.h

Go to the documentation of this file.

/* Copyright (c) 2022 Connected Way, LLC.
 * All rights reserved.
 *
 * This software is protected by copyright and intellectual 
 * property laws as well as international treaties.  It is to be 
 * used and copied only by authorized licensees under the 
 * conditions described in their licenses.  
 *
 * Title to and ownership of the software shall at all times 
 * remain with Connecetd Way.
 */
#if !defined(__SMB_FRAMEWORK_H__)
#define __SMB_FRAMEWORK_H__
 
#include "ofc/types.h"
#include "ofc/config.h"
#include "ofc/core.h"
#include "ofc/path.h"
#include "ofc/file.h"
#include "ofc/net.h"
 
#include "of_smb/smb.h"
#include "of_smb/persist.h"
 
typedef struct
{
  SMB_CONFIG_EXPORT_TYPE exportType ; 
  OFC_LPTSTR share ;              
  OFC_LPTSTR path ;           
  OFC_LPTSTR description ;        
  OFC_LPTSTR native_fs ;          
  OFC_BOOL encrypted;             
} OF_SMB_EXPORT ;
 
typedef struct
{
  OFC_UINT16 numExports ;   
  OF_SMB_EXPORT *exp ;      
} OF_SMB_EXPORTS ;
 
typedef struct
{
  OFC_BOOL enabled ;        
  OFC_LPSTR realm;      
  OFC_LPSTR fqdn;       
  OFC_LPSTR keytab;     
} OF_SMB_AUTH ;
 
typedef struct
{
  OFC_UINT16 numAuths ;     
  OF_SMB_AUTH *auth ;       
} OF_SMB_AUTHS ;
 
typedef struct
{
  OFC_LPTSTR name ;     
  OFC_LPTSTR ip ;       
  OFC_UINT16 port ;     
} OF_SMB_REMOTE ;
 
typedef struct
{
  OFC_UINT16 numRemotes ;   
  OF_SMB_REMOTE *remote ;   
} OF_SMB_REMOTES ;
 
#define SERVER_EVENT_INFO 0
#define SERVER_EVENT_ERROR 1
#define SERVER_EVENT_SECURITY 2
 
#if defined(__cplusplus)
extern "C"
{
#endif
OF_SMB_LIB OFC_VOID
of_smb_init(OFC_VOID);
 
OF_SMB_LIB OFC_VOID
of_smb_destroy(OFC_VOID);
 
OF_SMB_LIB OFC_VOID
of_smb_startup(OFC_HANDLE hScheduler);
OF_SMB_LIB OFC_VOID
of_smb_shutdown(OFC_VOID);
 
#if defined(OF_SMB_SERVER)
OF_SMB_LIB OFC_VOID 
of_smb_set_authentication_mode (SMB_CONFIG_AUTH_MODE mode);
 
OF_SMB_LIB OFC_LPTSTR of_smb_get_root_dir(OFC_VOID);
OF_SMB_LIB OFC_VOID ofc_smb_free_root_dir (OFC_LPTSTR str);
OF_SMB_LIB OF_SMB_EXPORTS *of_smb_get_exports (OFC_VOID);
OF_SMB_LIB OFC_VOID of_smb_free_exports (OF_SMB_EXPORTS *exports);
OF_SMB_LIB OFC_VOID of_smb_remove_export (OFC_LPCTSTR tszExport);
OF_SMB_LIB OFC_VOID of_smb_add_export (OF_SMB_EXPORT *export);
 
OF_SMB_LIB OF_SMB_AUTHS *of_smb_get_auths (OFC_VOID);
OF_SMB_LIB OFC_VOID of_smb_free_auths (OF_SMB_AUTHS *auths);
OF_SMB_LIB OFC_VOID of_smb_remove_auth (OFC_LPCSTR szRealm);
OF_SMB_LIB OFC_VOID of_smb_add_auth (OF_SMB_AUTH *auth);
OF_SMB_LIB OFC_HANDLE of_smb_startup_server(OFC_HANDLE hScheduler);
OF_SMB_LIB OFC_VOID of_smb_shutdown_server(OFC_HANDLE hApp);
#endif
OF_SMB_LIB OF_SMB_REMOTES *of_smb_get_remotes (OFC_VOID);
OF_SMB_LIB OFC_VOID of_smb_free_remotes (OF_SMB_REMOTES *remotes);
OF_SMB_LIB OFC_VOID of_smb_add_remote (OF_SMB_REMOTE *remote);
OF_SMB_LIB OFC_VOID of_smb_remove_remote (OFC_LPCTSTR name);
OF_SMB_LIB OFC_UINT of_smb_get_max_version(OFC_VOID);
OF_SMB_LIB OFC_VOID of_smb_set_max_version(OFC_UINT maxVersion);
OF_SMB_LIB OFC_VOID of_smb_enable_dialect(OFC_UINT dialect);
OF_SMB_LIB OFC_VOID of_smb_disable_dialect(OFC_UINT dialect);
OF_SMB_LIB OFC_BOOL of_smb_test_dialect(OFC_UINT dialect);
OF_SMB_LIB OFC_BOOL of_smb_get_server_enabled (OFC_VOID) ;
OF_SMB_LIB OFC_BOOL of_smb_get_server_wake (OFC_VOID) ;
OF_SMB_LIB OFC_TCHAR *of_smb_get_server_username (OFC_VOID) ;
OF_SMB_LIB OFC_TCHAR *of_smb_get_server_password (OFC_VOID) ;
OF_SMB_LIB OFC_VOID of_smb_set_server_enabled (OFC_BOOL on) ;
OF_SMB_LIB OFC_VOID of_smb_set_server_wake (OFC_BOOL on) ;
OF_SMB_LIB OFC_VOID of_smb_set_server_username (OFC_LPTSTR tstrName) ;
OF_SMB_LIB OFC_VOID of_smb_set_server_password(OFC_LPTSTR tstrPass) ;
OF_SMB_LIB OFC_INT of_smb_kinit (OFC_CHAR *principal, OFC_CHAR *password) ;
OF_SMB_LIB OFC_INT of_smb_kdestroy (OFC_VOID) ;
OF_SMB_LIB OFC_INT of_smb_kacquire (OFC_CHAR *fqdn, OFC_CHAR *keytab);
OF_SMB_LIB OFC_INT of_smb_krelease (OFC_VOID);
OF_SMB_LIB OFC_CHAR *of_smb_kactive(OFC_VOID);
OF_SMB_LIB OFC_CHAR *of_smb_kactive_user(OFC_VOID);
OF_SMB_LIB OFC_INT of_smb_get_max_events(OFC_VOID) ;
OF_SMB_LIB OFC_LONG of_smb_get_time_period(OFC_VOID);
OF_SMB_LIB OFC_VOID of_smb_set_max_events(OFC_INT maxEvents);
OF_SMB_LIB OFC_VOID of_smb_set_time_period(OFC_LONG timePeriod);
OF_SMB_LIB OFC_VOID of_smb_set_bootstrap_dcs(OFC_UINT count, OFC_CHAR **dc);
OF_SMB_LIB OFC_VOID of_smb_get_bootstrap_dcs(OFC_UINT *count, OFC_CHAR ***dc);
 
/*
 * callOnServerEvent is defined in com_connectedway_smb_Smb.c.  But it is
 * not technically a JNI binding.  Instead it is code to call a java class.
 * It cannot be declared in the corresponding .h file since those are generated
 * files.  We'll declare it here.
 */
 
 
void callOnServerEvent (int event, OFC_CCHAR * message) ;
 
OFC_VOID
smb_log_salt(OFC_CHAR *heading, OFC_UCHAR *salt, OFC_UINT salt_length);
 
OFC_VOID of_smb_resolve_name(OFC_LPCSTR name, OFC_UINT16 *num_addrs,
                             OFC_IPADDR *ip);
#if defined(__cplusplus)
}
#endif
#endif