Literal string encryption as part of the build process

• Download source files - 41.3 Kb

Introduction

What does it do?

What?

////////////////////
// my .CRX file
//
// here is my password definition:
// CXRP = "SexyBeast"		
//
// here are some strings:				

// my first string   
const char* pString1 = _CXR("AbcdEfg1234  blah\tblah"); 

// string #2
const char* pString2
       = _CXR("This is a long one, not that it should matter...");

As you can see, the only difference between this and standard C/C++ is the _CXR specifier. The comment line with the password is required, and any text you want encrypted must be inside a _CXR(...) specifier. Anything else in the file will be copied over to the output .CPP unchanged. So, that's how you set up the .CXR file. When you build your project, the CXR parser will read this file and generate a .CPP that looks like this:

///////////////////////////
#ifdef _USING_CXR
// my first string
const char* pString1 = "ab63103ff470cb642b7c319cb56e2dbd591b63a93cf88a";
#else
const char* pString1 = _CXR("AbcdEfg1234  blah\tblah");  // my first string
#endif

///////////////////////////
#ifdef _USING_CXR

// string #2
const char* pString2 = 
    "baff195a3b712e15ee7af636065910969bb24997c49c6d0cc6a40d3ec1...";
#else
// string #2
const char* pString2 = 
    _CXR("This is a long one, not that it should matter..."); 
#endif
...more stuff below...

Presto. The CXR parser has encrypted your strings.

OK, how do i get my strings back?

CString csString1 = _CRX(pString1);
// pString1 = "ab63103ff470cb642b7c319cb56e2dbd591b63a93cf88a"
// and now csString1 = "AbcdEfg1234  blah\tblah";

Note the #ifdef _USING_CXR tags. Because of these, you can disable the CXR strings by simply changing a single #define - to make testing easier. If _USING_CXR is not defined, all your strings revert to their unencrypted form and the "_CXR" turns into a macro that does nothing. If _USING_CXR is defined, your strings take on their encrypted forms and the _CXR macro becomes a call to the decrypting code. It's (almost) totally seamless.

It can't be that easy

Setting up

1. Build the CXR.EXE and put it somewhere in your path (in your WinNT or Windows folder, perhaps).
   
   
2. Create your .CRX file. Create a file that has your password definition and your literal text strings. Follow these rules:
   • A .CXR file must contain a password line of the form:

     // CXRP = "MyPasswordString"

     Where the password string is any string you want. The "// CXRP =" part is required.
     
     
   • All text strings that are to be encrypted must be enclosed in a _CXR(...) tag.
     
     
   • _CXR(...) tags can not span multiple lines.
     
     
   • CXR currently does not support Unicode. All your strings will be treated by the encoder as if they were ANSI strings. Using this in a Unicode build will probably cause you large headaches. Unicode support is planned in the future, but it isn't supported right now.

3. Create a .H file for your strings. Really, this is just a basic C/C++ issue. CXR will generate a .CPP file with your encoded strings. But, as with any extern strings, if you want to use them in your code, you have to define them somewhere. In the example above, I would create a file called "strings.h" and add the following:

   extern const char* pString1;
   extern const char* pString2;

4. Add the .CXR file to your project. You have to do this manually (right click on your project in the File View, select the .CXR file, etc.).
   
   
5. Add a new .CPP file to your project. The CXR parser will generate a .CPP file for you. But, you have to tell the compiler to compile it. So, add another file to your project. If your .CXR file was named "Strings.CXR", add "Strings.CPP" to your project - just type in the name when the file dialog pops up. Since this file doesn't exist yet, Visual Studio will ask if you want to add a reference to it anyway. Say Yes. The first time you build, the .CPP will be created.
   
   
6. Set the custom build options. Find your .CXR file in the Project / Settings, menu. Check "Always use custom build step". On the Custom Build tab, in the "Commands" section, enter the following:

   cxr.exe -i $(InputPath) -o $(ProjDir)\$(InputName).cpp

   This will cause Visual Studio to call CXR.EXE with the name of your .CXR file as input and the same name, but with a .CPP extension as output.

   In the "Outputs" section, enter:

   $(ProjDir)\$(InputName).cpp

   This tells the compiler that this file needs to be recompiled when the .CXR file changes.

7. Add cxr_inc.h to your project and add #include "cxr_inc.h" in every file in which you want to use the encrypted strings. There is a copy of this file in the sample "Test" project. But, it looks just like this:

   #ifndef CRXHeaderH
   #define CRXHeaderH
   
   #define _USING_CXR
   
   #ifndef _USING_CXR
   #define _CXR(x) x
   
   #else
   
   #define _CXR(x) __CXRDecrypt(x)
   extern CString __CXRDecrypt(const char *pIn);
   
   #endif
   
   #endif

   This file defines the macros you need to use to get your strings. This is also a good place to turn off the _USING_CXR macro, if you want to use your strings un-encrypted for any reason.

8. That's it! I know it looks like a lot. But again, the previous steps only have to be done once. After the setup is complete, the only interaction you'll have with CXR is when you edit and access your strings.

In detail

The encryption code is based on the quick and small Sapphire II stream cipher, from Crypto++. XOR would work equally as well, since we're only concerned about obfuscating the strings, not in keeping them secure against decryption attack.

You must be stupid. This won't stop crackers

Updates

• 9 Aug, 2002 - Changed character encoding from hex digits (1,2,3..f) to offset-based. This obscures the strings even better. Fixed the demo package.
• 17 Mar 2005 - updated source code

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)