We should all care as developers about security and how we store and use sensitive data, to either connect to databases, login to domain accounts etc.
Today I’m going to talk about how to encrypt usernames and passwords that are stored and saved to via an applications app.config. This article will use a custom configuration section called EncryptUserCredentials. I wont discuss how I created that here, but here is a sample app.config showing it, please not:
- service: key value to the record.
- userName: username.
- password: password.
I will not show you the implementation details and how you would access this in code, until another post. Today i will talk about how you can encrypt the EncyptedUserCredentials themselves, because at the moment they are plain text for all to see!
The way you accomplish this is using aspnet_regiis.exe, which all you ASP.NET web developers will know registers your web applications with IIS.
But wait, there are other functions this fine and dandy binary brings and that is encrypting sections in web.configs…..
But I’m using an App.Config silly.
Thats right, that doesnt matter. They are just config files to .NET, but with different names. So let me explain what you need to do, but before that, here is where aspnet_regiis is located on your Windows box:
|Version of .NET Framework
||Location of Aspnet_regiis.exe file
|.NET Framework version 1
|.NET Framework version 1.1
|.NET Framework version 2.0, version 3.0, and version 3.5 (32-bit systems)
|.NET Framework version 2.0, version 3.0, and version 3.5 (64-bit systems)
|.NET Framework version 4 (32-bit systems)
|.NET Framework version 4 (64-bit systems)
Before we move on, I must tell you we are focusing on a multi-machine configuration file encryption using RSA. If though your application is running on one machine only then you can use DPAPI and its provider DataProtectionConfigurationProvider. DPAPI is handled by Windows itself and uses specific machine keys and containers. These are not transferable to different machines. If you wanted to use the DPAPI method for a multi-machine scenario, aspnet_regiis would need to be run on a app.config on each machine it is deployed on.
Why is that a bad thing?
Simple, you would need to store a plain text app.config file as either part of the Continous Integration process or someone would need to manually keep a copy and run it on each machine or even include the plain copy in the installer if that was your method for deploying. This just adds a security weak point. You could include scripts to delete the plain text files, if this is the route you wanted to go down. But just so you know, DPAPI exists and could be a better option for you.
So aspnet_regiis allows you to create containers of asymmetric private/public keys and export them to other machines, allowing you one global config file to be used.
Step 0 – Preperation is (RSA) key
Yes yes, Step 0 exits because I got half way and forgot this step, thank the stars it was meant to be Step1! Add a configProtectedData section to your config with provider. Please note:
- keyContainerName – should be the name of the RSA container you will create later.
- name – Can be anything. Im naming mine MyEncryptionProvider.
Step 1 -Espionage….
Yes i said aspnet_regiis wont have a problem with an App.config – it wont, but first you need to rename/copy said App.config file to web.config.
copy app.config web.config
Step 2 – Rise and Serve
Create a public/private RSA key pair with a specfic container name. They should also be marked as exportable (otherwise what is the point!). MyCustomKeys can be anyname you desire.
aspnet_regiis.exe -pc MyCustomKeys -exp
Step 3 – Let me in!
Grant permissions for accounts to access the container. Example here is the network service say IIS uses.
aspnet_regiis.exe -pa MyCustomKeys "NT AUTHORITY\NETWORK SERVICE"
Step 4 – Encrypt and Protect
Now the magic happens. The following line will now encrypt your section (my EncryptedUserCredentials are wrapped in section CustomConfg). The -pef switch is telling the application to look for a web.config file and to use my provider I declared in Step 0 (which is using type RsaProtectedConfigurationProvider).
aspnet_regiis.exe -pef CustomConfig . -prov MyEncryptionProvider
You web.config file should now have transformed. Gone is the CustomConfig section with plain text credentials, now there is a nice CyperValues. Please note mine below have been replaced with hard coded text, but you will see what i mean when you do yours. Also note your CustomConfig section now declares it uses a configProtectionProvider=MyEncryptionProvider.
Step 5 – Export those Keys
So now we have created our web.config file you can rename it to app.config and use this in your application. To use it on different machines though, you will need to export the keys from the machine that you created the encrypted web/app.config file and import them onto each machine. Firstly on your machine run the following which will create the key file for your container, including the private keys (-pri).
aspnet_regiis.exe -px MyCustomKeys keys.xml -pri
Step 5 – Import those Keys
Log into the machine(s) you wish your application to work on and run the following
aspnet_regiis -pi MyCustomKeys keys.xml
I would do this as part of your Release or Installation process making sure you delete the keys.xml file from the installed machines. The only place the keys.xml should be kept is in your code repository store but somewhere safe where it is restricted. This is the security issue for the RSA approach.
The full encrypt and export script can be found here. Amend it to include your custom container, section and provider names.