(PureBasic) How to Generate an Azure Service Bus Shared Access Signature (SAS)

Demonstrates generating and using an Azure Service Bus Shared Access Signature (SAS).

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkFileAccess.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthAzureSAS.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    ; Note: Requires Chilkat v9.5.0.65 or greater.

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

    ; -------------------------------------------------------------------
    ; Create a Shared Access Signature (SAS) token for Azure Service Bus.
    ; -------------------------------------------------------------------

    authSas.i = CkAuthAzureSAS::ckCreate()
    If authSas.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureSAS::setCkAccessKey(authSas, "AzureServiceBus_PrimaryKey")

    ; The SAS token for Service Bus will look like this:
    ; (The order of params will be different.  The order does not matter.)
    ; sig=<signature-string>&se=<expiry>&skn=<keyName>&sr=<URL-encoded-resourceURI>

    ; Specify the format of the string to sign.
    CkAuthAzureSAS::setCkStringToSign(authSas, "resourceURI,expiry")

    ; Create an expiry to 30 days in the future.
    dtExpiry.i = CkDateTime::ckCreate()
    If dtExpiry.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(dtExpiry)
    CkDateTime::ckAddDays(dtExpiry,30)
    CkAuthAzureSAS::ckSetTokenParam(authSas,"expiry","se",CkDateTime::ckGetAsUnixTimeStr(dtExpiry,1))

    ; Set the skn (keyname)
    ; This example uses the key "RootManageSharedAccessKey".  This give full access.
    ; In a typical scenario, you would create a new Azure key (for the service bus)
    ; in the Azure portal, such that the key has limited permissions.  This would
    ; allow you to give the SAS token to others for specific access for some period of time.
    CkAuthAzureSAS::ckSetTokenParam(authSas,"keyName","skn","RootManageSharedAccessKey")

    ; Set the URL-encoded-resourceURI
    sbResourceUri.i = CkStringBuilder::ckCreate()
    If sbResourceUri.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbResourceUri,"https://<yournamespace>.servicebus.windows.net/")
    CkStringBuilder::ckEncode(sbResourceUri,"url","utf-8")
    CkAuthAzureSAS::ckSetTokenParam(authSas,"resourceURI","sr",CkStringBuilder::ckGetAsString(sbResourceUri))

    ; Generate the SAS token.
    sasToken.s = CkAuthAzureSAS::ckGenerateToken(authSas)
    If CkAuthAzureSAS::ckLastMethodSuccess(authSas) <> 1
        Debug CkAuthAzureSAS::ckLastErrorText(authSas)
        CkAuthAzureSAS::ckDispose(authSas)
        CkDateTime::ckDispose(dtExpiry)
        CkStringBuilder::ckDispose(sbResourceUri)
        ProcedureReturn
    EndIf

    Debug "SAS token: " + sasToken

    ; Save the SAS token to a file.
    ; We can then use this pre-generated token for future Service Bus operations.
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/serviceBusSas.txt",sasToken,"utf-8",0)


    CkAuthAzureSAS::ckDispose(authSas)
    CkDateTime::ckDispose(dtExpiry)
    CkStringBuilder::ckDispose(sbResourceUri)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure