SQL Server

Client Certificate in REST

See more REST Examples

Demonstrates how to use a client certificate with a REST connection. SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- This example shows how to use the Chilkat socket object's connection.
    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @socket int
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @socket OUT

    -- Set the certificate to be used for mutual TLS authentication
    -- (i.e. sets the client-side certificate for two-way TLS authentication)
    -- Note: There are other ways to set the client certificate using Chilkat.
    -- For example, on Windows systems, a Chilkat certificate object could be loaded with certificate
    -- pre-installed (with private key) in a Windows certificate store, and then socket.SetSslClientCert could be called.
    EXEC sp_OAMethod @socket, 'SetSslClientCertPfx', @success OUT, '/home/bob/pfxFiles/myClientSideCertWithPrivateKey.pfx', 'pfxPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- Note: The certificate used for the client-side of TLS mutual authentication
    -- must have the associated private key available. (.pfx/.p12 files typically store both
    -- the certificate and associated private key.)

    -- Establish the connection using the socket object (with client certificate authentication).
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @maxWaitMs int
    SELECT @maxWaitMs = 5000
    EXEC sp_OAMethod @socket, 'Connect', @success OUT, 'www.example.com', @port, @bTls, @maxWaitMs
    IF @success <> 1
      BEGIN

        EXEC sp_OAGetProperty @socket, 'ConnectFailReason', @iTmp0 OUT
        PRINT 'Connect Failure Error Code: ' + @iTmp0
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1

    -- Use the connection:
    EXEC sp_OAMethod @rest, 'UseConnection', @success OUT, @socket, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- At this point we are connected and can make REST calls...
    -- For example..
    DECLARE @responseJson nvarchar(4000)
    EXEC sp_OAMethod @rest, 'FullRequestNoBody', @responseJson OUT, 'GET', '/someQuery'
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @socket


END
GO