Skip to main content

How to do Auditing in web application with Context Info


Background 


Last couple of days I had issues while trying to implement the audit in one of the asp.net application.  Especially if tables don’t have the structure to accommodate who modified or when modified fields. So what will do? Is it practical to add all this fields in tables and implement auditing? Yes if you have 5 or 10 tables. What happens if there are 100’s of tables?

 I came across this issue. Fortunately some one told about the ContextInfo. Before starting a database connection set the context info with the current user details. And when the operation finishes call a trigger and update the auditing table with contextInfo.

What time context info update?
For all db operation a connection need to open. So conextinfo can be set after the open connection.

 create an OpenConnection() method in the base class which all Execute…() methods call, instead of calling cmd.Connection.Open() directly. Then call SetConext method there.

Implementation


1. OpenConnection

internal override void OpenConnection(IDbConnection con)
        {
            con.Open();
            //For Auditing purpose
            SetContext(con as SqlConnection);
        }

2. SetContext

protected virtual void SetContext(IDbConnection conn)
        {
            string currentUserName = GetCurrentUserName();
            string spName = "sp_set_context";

            if (conn != null)
            {
                if (conn.State != ConnectionState.Open)
                    conn.Open();
              
                IDbCommand cmd = conn.CreateCommand();
                cmd.CommandType = CommandType.StoredProcedure;
                cmd.CommandText = spName;

                IDbDataParameter param = cmd.CreateParameter();
                param.ParameterName = "@username";
                param.DbType = DbType.String;
                param.Size = 255;
                param.Value = currentUserName;
                cmd.Parameters.Add(param);

                cmd.ExecuteNonQuery();
            }
        }

3. sp_set_current_context

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE PROCEDURE [dbo].[sp_set_context]
      @username nvarchar(256)
AS
BEGIN
      -- SET NOCOUNT ON added to prevent extra result sets from
      -- interfering with SELECT statements.
      SET NOCOUNT ON;

    declare @Ctx varbinary(128)
     
      select @Ctx = convert(varbinary(128), @username)
      set context_info @Ctx
END




GO

4.Function


SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO


ALTER FUNCTION [dbo].[f_get_current_user]()
RETURNS uniqueIdentifier
AS
BEGIN

DECLARE @Username nvarchar(256)
DECLARE @UserId uniqueIdentifier
DECLARE @Ctx varbinary(128)
SELECT @Ctx = CONTEXT_INFO()
SELECT @Username = CAST( @Ctx AS nvarchar(256)) 
IF (@Username is null or @Username = '') select @Username = SYSTEM_USER

SELECT @UserId=UserId from Users where UserName=@Username;

RETURN @UserId
END


5.Trigger


SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE TRIGGER [dbo].[TR_audit_log] ON [dbo].[TableName] FOR INSERT, DELETE, UPDATE
AS
BEGIN
      SET NOCOUNT ON;
      IF TRIGGER_NESTLEVEL(OBJECT_ID('TR_audit_log')) > 1 RETURN

      DECLARE @user_key uniqueidentifier, @tp INT = 0
      IF EXISTS(SELECT 1 FROM deleted) SET @tp = @tp + 1
      IF EXISTS(SELECT 1 FROM inserted) SET @tp = @tp + 2
     
      DECLARE @i TABLE (Id int, Name nvarchar(100), audit_data VARCHAR(MAX),
                  PRIMARY KEY (Id))
      DECLARE @d TABLE (Id int, Name nvarchar(100), audit_data VARCHAR(MAX),
                  PRIMARY KEY (Id))
      INSERT INTO @i SELECT Id, Name,
            (SELECT Id, Name

                        FOR XML RAW('audit'))
      FROM inserted

      INSERT INTO @d SELECT Id, Name,
            (SELECT Id, Name

                        FOR XML RAW('audit'))
      FROM deleted

     

      IF @tp = 2
      BEGIN
            INSERT INTO audit_log ()
      END ELSE IF @tp = 1
      BEGIN
            INSERT INTO audit_log ()
      END ELSE
      BEGIN
            INSERT INTO audit_log (
)
                  END
      SET NOCOUNT OFF;
END


GO





Comments

  1. Nice post! This is a very nice blog that I will definitively come back to more times this year! Thanks for the informative post. download WebSite Auditor

    ReplyDelete

Post a Comment

Popular posts from this blog

Emergence and Creative Confidence

I started my career on 1st of September 2008 as a software developer at Manchester. Some people in my personal life might know about it. I like to say, that day as the day I found an aura in my life, transformation from the worst possible situation into a new beginning in a matter of 1 hour. The week before, I got an interview confirmation from that company and I was not at all excited about it because I know it is going to be the final interview in UK if I am unsuccessful. I was in that mental state because I was not successful for past 12 such occurrences and not expecting anything different. This shows I was not a brilliant person but had a strong passion and hardworking nature to achieve success. I passed my masters on Sep 2007 and after that, I decided to work only in software development, and lots of people including my parents told this as a worst possible decision. To be precise, they have no issues in choosing software development, but on my adamant decision only software de...

Bootstrap Server Side Sorting Cont....

On my previous post   I had already mentioned about how to apply the sort to Bootstrap paginated tables. By making the following changes server side sorting can be achieved along with pagination. On Filter Model self.sortBy = ko.observable( 'Id' );//Default sort Column self.sortAscending = ko.observable( false ); self.iconType = ko.observable( 'glyphicon glyphicon-chevron-down' ); // Icon to appear near Column No Changes to Adarsh Log Model or Adarsh Log list Model Knockout.js View Model for Adarsh Log Changes Add the sortTable  method to it self.sortTable = function (viewModel, e) {             var columClicked = $(e.target).attr( "data-column" )             var sortAscending = (self.filter().sortAscending() === true ) ? false : true ;             self.filter().sortAscendi...

Single page application (SPA) using ext.js

what is spa? Single page application are applications that fit in one page with rich and fluid user experiences like a desktop based applications. Why is SPA? All web based elements (html, CSS,javascript) are downloaded from the server on single page load and avoid the continuous page post back. i can explain what this mean. Suppose your web application is made of certain flow and it consists of 5 different pages. Each page need to get data from the user and save before moving to the next page. So when we navigate from one page to other it need to make a round trip to server to store the data in one page and get the data for the next page to display. but in spa we can avoid the continuous post backs. The whole page will not post back any time other than the first load. But it communicate to the server dynamically behind the scene and can achieve the same functionality. Spa using ext.js designing a SPA using ext.js is a challenging task if you are unaware about the ext.js ...