git.zerfleddert.de Git - proxmark3-svn/blob - client/loclass/fileutils.h

   1 /*****************************************************************************
   2  * WARNING
   3  *
   4  * THIS CODE IS CREATED FOR EXPERIMENTATION AND EDUCATIONAL USE ONLY.
   5  *
   6  * USAGE OF THIS CODE IN OTHER WAYS MAY INFRINGE UPON THE INTELLECTUAL
   7  * PROPERTY OF OTHER PARTIES, SUCH AS INSIDE SECURE AND HID GLOBAL,
   8  * AND MAY EXPOSE YOU TO AN INFRINGEMENT ACTION FROM THOSE PARTIES.
   9  *
  10  * THIS CODE SHOULD NEVER BE USED TO INFRINGE PATENTS OR INTELLECTUAL PROPERTY RIGHTS.
  11  *
  12  *****************************************************************************
  13  *
  14  * This file is part of loclass. It is a reconstructon of the cipher engine
  15  * used in iClass, and RFID techology.
  16  *
  17  * The implementation is based on the work performed by
  18  * Flavio D. Garcia, Gerhard de Koning Gans, Roel Verdult and
  19  * Milosch Meriac in the paper "Dismantling IClass".
  20  *
  21  * Copyright (C) 2014 Martin Holst Swende
  22  *
  23  * This is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License version 2 as published
  25  * by the Free Software Foundation.
  26  *
  27  * This file is distributed in the hope that it will be useful,
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  * GNU General Public License for more details.
  31  *
  32  * You should have received a copy of the GNU General Public License
  33  * along with loclass.  If not, see <http://www.gnu.org/licenses/>.
  34  *
  35  *
  36  *
  37  ****************************************************************************/
  38
  39 #ifndef FILEUTILS_H
  40 #define FILEUTILS_H
  41 /**
  42  * @brief Utility function to save data to a file. This method takes a preferred name, but if that
  43  * file already exists, it tries with another name until it finds something suitable.
  44  * E.g. dumpdata-15.txt
  45  * @param preferredName
  46  * @param suffix the file suffix. Leave out the ".".
  47  * @param data The binary data to write to the file
  48  * @param datalen the length of the data
  49  * @return 0 for ok, 1 for failz
  50  */
  51 int saveFile(const char *preferredName, const char *suffix, const void* data, size_t datalen);
  52 /**
  53  * @brief Utility function to save load binary data from a a file. This method takes a filename,
  54  * Should only be used for fixed-size binary files
  55  * @param fileName the name of the file
  56  * @param data a buffer to place data in
  57  * @param datalen the length of the data/data.
  58  * @return
  59  */
  60
  61 int loadFile(const char *fileName, void* data, size_t datalen);
  62
  63 /**
  64  * Utility function to print to console. This is used consistently within the library instead
  65  * of printf, but it actually only calls printf. The reason to have this method is to
  66  *make it simple to plug this library into proxmark, which has this function already to
  67  * write also to a logfile. When doing so, just delete this function.
  68  * @param fmt
  69  */
  70 void prnlog(char *fmt, ...);
  71 #endif // FILEUTILS_H