Introduction
This article is about a license key generation program. As you know when you get a software package it usually requires a license key. The keys that are generated show various pieces of information, such as product, customer and version. With this program and library you can create the key and later read it in to validate that the correct key was used. This is used not only for selling commercial products but also in deploying enterprise applications. With a license key you can turn features on and off for each customer, have product feature expire at the end of a demo period, or any other type of enabling or disabling you desire. Since I wanted to put this code in CodeProject I adhered to using NUnit as my unit testing tool, NDoc as my documentation tool, and FxCop as my code analyzer. In this project, I created an interactive test tool to test the various features of the library.
Background
There are various ways to create keys; this article shows one such way. Another site that does License keys is SP extreme or Open License.
Using the code
The license keys are created with either a base 10 or base 16 integer data set. Most keys are base 16 for all of the numbers. The license key template is a string of characters that represent what actions will be taken when the key is created and decoded. Two types of templates are Bytes and Bits. Bytes are used when the key will be a simple key that does not require a lot of fields and data encoding. Bits are used when there will be more fields and the encoding will be harder to decipher. This version requires that all fields be on the byte boundary so it is a little easier to decipher the end result. The next version will not be aligned on a byte boundary so it will be harder to decipher. The key template has two characters that are defined by default. The x character states just a filler or random number. The c character defines a checksum character. These two characters are the only two that are reserved.
A sample of the template and the resulting license key for Byte values and Decimal numbers are:
xxxxxxxx-xx-xxxxxxxx-xx
69658998-12-12031517-23
A sample of the template and the resulting license key for Bit values and Hex numbers are:
xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx
BC017-06777-14871-160C4
With this library you can define the tokens that you want to replace real values with, such as product numbers, version numbers, serial numbers, or user counts.
GenerateKey gkey;
gkey = new GenerateKey();
gkey.LicenseTemplate = "xxxxxxxx-xxxx-xxxxxxxx-xxxx";
gkey.MaxTokens = 0;
gkey.UseBase10 = true;
gkey.UseBytes = true;
gkey.CreateKey();
finalkey = gkey.GetLicenseKey();
The above example shows how to create a license key that has no tokens, uses base 10 numbers, and uses bytes for the template definition. Since no tokens are used, it really just creates a random number.
GenerateKey gkey;
gkey = new GenerateKey();
gkey.LicenseTemplate = "vvvvppppxxxxxxxxxxxx" +
"-xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx" +
"-xxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx";
gkey.MaxTokens = 2;
gkey.AddToken(0, "v", LicenseKey.GenerateKey.TokenTypes.NUMBER, "1");
gkey.AddToken(1, "p", LicenseKey.GenerateKey.TokenTypes.NUMBER, "2");
gkey.UseBase10 = false;
gkey.UseBytes = false;
gkey.CreateKey();
finalkey = gkey.GetLicenseKey();
This example shows how to create a license key that has two tokens. The first token sets the version to use a token of v with a value of 1. The second token sets the product to use a token of p with a value of 2. It also uses hex numbers and bits for the template definition. The various token types are NUMBER, CHARACTER, and DATE. In NUnit, the NUMBER and CHARACTER types are used extensively. I have not finished DATE as of this article but will do so later. At this time I am not sure if you need it since you have NUMBER available to use. The original reason I thought DATE might be of value is it might pack better than just using numbers.
Some of the additional classes that I had to write to support the license key generation are a random number generator, a data type parser, a number display class, and a checksum class.
The random number class uses the C# Random class but adds some additional methods to support the requirements. The methods are:
The checksum number class uses checksum routines that are pretty basic. Additional advanced algorithms can be added simply by adding the routine and an enumerated type. The methods are:
Since so many variations of a license key can be done I did all of the unit tests using NUnit. Another advantage of NUnit was that if I fixed something in one area I could also make sure that I did not break something or another. Since the keys are using random numbers, I iterated thirty times in many of the tests to make sure the numbers matched. As part of the tests, I also decoded the same key to make sure that whatever I encoded I also decoded the same value.
When you open the solution, you will notice there are three projects. One is the library so that when it is built anyone can use it. The second is an interactive test program so that you can test individual license keys and tokens. The third is the NUnit project so that you can add, run and debug the unit tests.
Points of Interest
Doing bit shifts in C# is somewhat different than C++ in that they are not allowed on chars only on integers. The time saving that I made by doing the entire unit test in NUnit was well worth the effort, I never would have had this much code coverage without using it. The Help system is written using NDoc so that is it in a standard format. Not to mention it is easier to search and use. For the library part, I ran FxCop routinely to make sure many of the best practices are adhered to.
History
If everyone is interested I can put the code at SourceForge as well. This way others can add, update or use the source code. I plan on adding the ability to set tokens on bit boundaries and not just on byte boundaries.
