SQL Server 2005/2008 CLR support by example: crypt() UDF in C#
.NET programmability support has been one of the big novelties of SQL Server 2005. Sometimes I had the impression that CLR support was also one of the most misunderstood features of the new platform. Some people considered moving their existing pre-2005 T-SQL code to .NET in an attempt to gain more efficiency by using a ‘compiled’ programming language.
This was a bit of a common misbelief, since stored T-SQL procedures and functions are also optimized/compiled prior to execution. Performance gains by using .NET code instead of T-SQL are usually limited to highly iterative/procedural code, and not for optimizing anything which can be easily done within native SQL.
Let us have a look at a simple user defined function written in C#. This function takes a clear text string and a 2 character salt parameter and calculates a Unix crypt hash based on both.
public partial class UserDefinedFunctions { [Microsoft.SqlServer.Server.SqlFunction( IsDeterministic=true )] public static SqlString Crypt( SqlString sPlainText, SqlChars cSalt ) { if ( sPlainText.IsNull || cSalt.IsNull || cSalt.Length < 2 ) return SqlString.Null; string sSalt = new string( cSalt.Value ); sSalt = sSalt.Substring( 0, 2 ); return new SqlString( UnixCrypt.Crypt( sSalt, sPlainText.Value ) ); } }
We just declare a class with a static function qualified as a SqlFunction that accepts and returns classes/structs of the System.Data.SqlTypes namespace. The UnixCrypt.Crypt method contains the actual code which I am excluding here. If you are interested in building this example, you can find a working implementation of the crypt class in C# at The Code Project.
After compiling the above code into a dll, you may load it into SQL Server and run it with the following commands:
-- CLR support is disabled by default EXEC sp_configure 'clr enabled' , '1' GO reconfigure; GO -- load dll and create assembly CREATE ASSEMBLY asmYourAssembly FROM 'D:\Your\Path\to\CryptUDF.dll' WITH PERMISSION_SET = SAFE GO -- add a function that references the CLR UDF CREATE FUNCTION dbo.Crypt( @plain AS NVARCHAR(200), @salt AS NCHAR(2) ) RETURNS NVARCHAR(200) AS EXTERNAL NAME asmYourAssembly.UserDefinedFunctions.Crypt GO SELECT dbo.Crypt( 'password', 'xy' );
Note PERMISSION_SET = SAFE, which reflects the external dependencies on framework libraries. Since we are doing all our calculations within the library, there is nothing additional we need to reference, which permits us to be running within the safest permission set. You can learn more about the CLR integration permission sets on MSDN.
When doing authentication, you could use the UDF as follows:
SELECT @UserID=[UserID] FROM dbo.tblAccounts WHERE [UserName]=@Username COLLATE Latin1_General_CI_AS AND dbo.Crypt( @Password, [Password] )=[Password] COLLATE Latin1_General_CS_AS
Note that we are doing a case insensitive compare on the UserName column and a case sensitive compare on the crypt hash of the crypt hash column.
Why does it make sense to do authentication like this inside the database instead of calculating the password hash outside of the database and then just pass it to a WHERE Username=@Username AND Password=@Password query?
The reason lies in the nature of the crypt function: the hash it creates is based on a two character prefix or salt, which has to be used for hashing the candidate password prior to comparing it with the original password hash. Since the above approach can be completely encapsulated within a stored procedure, no hashes or salts need to be returned to the calling application for verifying the correctness of the password.
Where is this used today? While Unix and Linux user authentication is the classic usage of the crypt function, also some internet services are relying on it. E.g. the PayPal IPN feature for selling subscription accounts is transmitting passwords as crypt hashes only.