/usr/include/zuluCrypt/libzuluCryptPluginManager.h is in libzulucryptpluginmanager-dev 5.4.0-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | /*
*
* Copyright (c) 2012-2015
* name : Francis Banyikwa
* email: mhogomchungu@gmail.com
* 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 2 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 <http://www.gnu.org/licenses/>.
*/
#ifndef ZULUCRYPTPLUGINMANAGER
#define ZULUCRYPTPLUGINMANAGER
#include <stddef.h>
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* This header and its associated library with the same name provide a plugin infrastructure
* that allow passage of keys from a key module to zuluCrypt-cli in a safe way.
*
* In your key module, call functions in this header file to pass the key to zuluCrypt-cli
*
* The following options will be passed to the module.
* argv[0] - the name of the module
* argv[1] - the device path with the encrypted volume to be opened
* argv[2] - the UUID of the encrypted volume or "Nil" if the encrypted volume has no UUID( plain volume )
* argv[3] - a token to be used for communication btw the plugin and zuluCrypt-cli.
* argv[4] - the maximum number of bytes that will be read.
* argv[5] - the command line argument list as presented to zuluCrypt-cli
*/
/*
* This function opens a connection btw the plugin and zuluCrypt-cli.
*
* NULL is returned if the connection can not be made.
* This function will block while trying to establish a connection.
*/
void * zuluCryptPluginManagerOpenConnection( const char * token ) ;
/*
* This function sends the key to zuluCrypt-cli through a connection established by the command above.
* The first argument is a handle returned above
* The second argument is a buffer to the key to be sent
* The third argument is the length of the buffer
*/
ssize_t zuluCryptPluginManagerSendKey( void * handle,const char * key,size_t length ) ;
/*
* Close the connection and free up all used memory.
*/
void zuluCryptPluginManagerCloseConnection( void * handle ) ;
/*
* Sample plugin on how to use the library
*
* #include <zuluCrypt/libzuluCryptPluginManager.h>
* #include <stdlib.h>
*
* int main( int argc,char * argv[] )
* {
* const char * exe = argv[0] ;
* const char * device = argv[1] ;
* const char * uuid = argv[2] ;
* const char * token = argv[3] ;
* int len = atoi( argv[4] ) ;
* const char * arg = argv[ 5 ] ;
*
* void * handle = zuluCryptPluginManagerOpenConnection( token ) ;
*
* zuluCryptPluginManagerSendKey( handle,"xyz",3 ) ;
*
* zuluCryptPluginManagerCloseConnection( handle ) ;
*
* return 0 ;
* }
*/
#ifdef __cplusplus
}
#endif
#endif
|