Files
sql-server-samples/samples/features/security/ledger/sql-server/README.md
T
2022-12-01 13:45:20 +01:00

8.1 KiB
Raw Blame History

Ledger SQL Server - Demo

The demo in this folder showcases the ledger feature in SQL Server. The demo uses the Contoso World Cup application.

Content

About this sample Before you begin Setup Demo - show the main benefits of the ledger feature

About this sample

  • Applies to: SQL Server 2022 (16.x)
  • Key features: Ledger
  • Workload: World Cup Betting application
  • Programming Language: C#, Transact-SQL
  • Authors: Pieter Vanhove
  • Update history:

Before you begin

Before you begin, you need an Azure subscription. If you don't already have an Azure subscription, you can get one for free here.

You also need to make sure the following software is installed on your machine:

  1. SQL Server 2022. Even SQL Server 2022 Express edition should be sufficient for this demo.
  2. Visual Studio Code.
  3. SQL Server Management Studio (SSMS) - version 18.12.1 or later is required.
  4. Azure Data Studio - version 1.41 or later is required.

Setup

Azure Storage Account

  1. Go to the Azure Portal and create a new resource group that will be used for the demo environment.
  2. Create a new Azure Storage Account in the resource group. Make sure you enable version-level immutability support on the storage account to ensure that database digests are protected from tampering. Make sure the immutability policy allows protected append writes to append blobs and that the policy is locked.
  3. Follow the steps on Azure Storage account permission to create a credential on the SQL Server Instance.

Database

  1. Clone/download and unpack the repository.
  2. Open SQL Server Management Studio and connect to your SQL Server 2022 instance.
  3. Open the file CreateDatabaseSchemaAndPopulateDatabase.sql
  4. Go to line 12 and replace YourStorageAccountName with the name of the Azure storage account you just created.
  5. Run the script. This will
    1. Create the database
    2. Create the database schema
    3. Create a function to calculate the payout
    4. Create a stored procedure to place bets
    5. Configure the automatic digest storage
    6. Populate the database.

Web Application

  1. Open Visual Studio
  2. Open the folder WorldCup
  3. Click on the file Program.cs in the Explorer and go to line 25
  4. Change the Server parameter in the connection string to the name of your SQL Server Instance.
  5. Save your modifications.

Demo - show the main benefits of the ledger feature

Scenario

Contoso Cup Betting is using a simple web application where people can place bets, in this case bets on soccer games.

In this demo you will use 2 different types of users:

  • Pieter, the DBA of the company.
  • Michael, who is an internal auditor.

All the games and bets that are placed needs to be immutable. Using ledger tables is a good solution for this since the data of all the bets and the games needs to be fully trusted. It prevents the company from removing or updating any placed bets. Pieter, who has placed a few bets on some games, wants to maliciously increase his payout. Unfortunately for Pieter, the bets table is an append-only ledger table, which means he can't change his bets with regular T-SQL updates. Pieter knows how to tamper with the data directly in the data file and thinks his change will never be noticed. However, Michael reviews the Worldcup database after the tournament is over and noticed that the verification procedure fails, which means that the data cannot be trusted.

Prepare for the demo

Perform the below steps before you show the demo.

  1. Connect to the database

    1. Start the Azure Data Studio.
    2. Open the Notebook Ledger - World Cup Demo - SQL Server 2022
    3. Attach the Notebook to the SQL Server Instance and WorldCup database you have created during the demo Setup.
  2. Prepare a browser window .

    1. Open Visual Studio
    2. Open the folder WorldCup
    3. Go to the top menu and click Terminal - New Terminal
    4. In the terminal window type dotnet run. This will launch the web application.
    5. Open your browser and enter the following URL http://localhost:3000

Contoso Cup Betting

Demo steps

  1. Show the app and the database.

    1. Show the Contoso World Cup web app in the browser. Explain that this is a list of all the soccer games. Show that you are logged in as Pieter (the DBA of the company) and place a bet. Place Bet
    2. Once you have placed the bet, show that the user can download a cryptographic receipt that proves the bet. This receipt could also be used to verify the database afterwards but is not part of this demo. Download Cryptographic Receipt
    3. Go to the Notebook and show the 2 tables, Moneyline and bets in the Explorer. Explain that Moneyline table is an updatable ledger table and bets an append-only ledger table. Ledger Tables
    4. Run the code cell 1 in the Notebook to show the games in the Moneyline table.
  2. Show how ledger captures history information in the updatable ledger table

    1. Pieter has been asked to change the Home Country Odds for the game with ID 1. Run code cell 2 in the Notebook to update the record.
    2. Run code cell 3 in the Notebook to show the history of the updated record. Explain that updates are stored as 2 records. A delete of the old version and an insert of the new version of the row.
  3. Show how append-only ledger table works and how ledger helps investigate tampering by DBAs.

    1. Michael, who is an internal auditor, performs a routine review of changes in the Worldcup database. As his first step, Michael runs the ledger verification to be sure he can trust the data hes going to examine. Run code cell 4 to execute the verification stored procedure. The result should be "Success"!
    2. Pieter wants to maliciously increase his payout for the game he betted on. Run code cell 5 and 6 to try to update the record. Explain that update on an append-only ledger table is blocked.
    3. Pieter thinks he's smart and tampers with the data directly into the data file by using a stored procedure. Do not run code cell 7 because the stored procedure does not exists.
    4. Michael, reviews the Worldcup database again after the tournament is over. He noticed that the verification procedure failed. Observe the results of code cell 8 to see evidence of tampering in a database ledger. DO NOT RUN the cell just review the pre-run results to see tampering in action.
    5. Review the history of the transaction and show to the audience that you can verify which transactions cannot be trusted. DO NOT RUN the cell just review the pre-run results.

Key Takeaways

Ledger makes your data tamper-evident and cryptographically verifiable, which helps ensure non-repudiation, eliminating a need to run laborious manual audits and time-consuming investigations.