(PureBasic) Oracle Cloud Secrets - Get a Binary Secret

See more Secrets Examples

Demonstrates how to fetch the content of a binary secret from the Oracle Cloud Secrets.

Note: This example requires Chilkat v10.1.0 or later.

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkSecrets.pb"

Procedure ChilkatExample()

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

    ; The bootstrap secret will contain the following information:

    ; Private Key PEM

    ; See following examples for setting up a bootstrap secret in memory, 
    ; or in the local manager (Windows Credentials Manager or Apple Keychain)
    ; Setup Bootstrap Secret in Local Manager
    ; Setup Bootstrap Secret in Memory
    bootstrap.i = CkSecrets::ckCreate()
    If bootstrap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the location of the bootstrap secret.
    ; Can be "local_manager" or "memory", depending on how you setup the bootstrap secret.
    ; ---------------------------------------------------------------------------------------------
    ; If your operating system is NOT Windows or MacOS/iOS, then change "local_manager" to "memory"
    ; You can also, if desired, use "memory" on Windows and MacOS/iOS if your bootstrap secret was previously setup in memory.
    ; ---------------------------------------------------------------------------------------------
    CkSecrets::setCkLocation(bootstrap, "local_manager")

    ; Specify the bootstrap secret to be used.
    bsId.i = CkJsonObject::ckCreate()
    If bsId.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(bsId,"appName","oracle_bs")
    CkJsonObject::ckUpdateString(bsId,"service","Example")
    CkJsonObject::ckUpdateString(bsId,"username","Joe")

    ; ----------------------------------------------------
    secrets.i = CkSecrets::ckCreate()
    If secrets.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Setup for the Oracle Cloud Secrets
    CkSecrets::setCkLocation(secrets, "oracle_cloud")
    success.i = CkSecrets::ckSetBootstrapSecret(secrets,bsId,bootstrap)
    If success = 0
        Debug CkSecrets::ckLastErrorText(secrets)
        CkSecrets::ckDispose(bootstrap)
        CkJsonObject::ckDispose(bsId)
        CkSecrets::ckDispose(secrets)
        ProcedureReturn
    EndIf

    ; Specify the secret to be fetched.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"appName","Test2")
    CkJsonObject::ckUpdateString(json,"service","Custom")
    CkJsonObject::ckUpdateString(json,"domain","Ocean")
    CkJsonObject::ckUpdateString(json,"username","Starfish")

    ; Oracle Cloud Secrets requires a lot of additional information for each API call.
    ; You'll need to replace the following with your values.
    ; Note: To learn how to find these values, go to an AI such as ChatGPT and ask (for example) "In Oracle Cloud, where do I find my master key OCID?"
    CkJsonObject::ckUpdateString(json,"vault_name","ocid1.vault.oc1.us-chicago-1.ijttzlz7aadxo.abxxeljt4gv6tgrar66i5ugffincjmp52oveht3y2zn74rgo6raz6h72qtia")
    CkJsonObject::ckUpdateString(json,"region","us-chicago-1")
    CkJsonObject::ckUpdateString(json,"tenancy_ocid","ocid1.tenancy.oc1..aaaaaaaaov6vd3xdybgvwblezx2kmgjmo3dvsuljbwpf2m27mk47kkxsa5aa")
    CkJsonObject::ckUpdateString(json,"user_ocid","ocid1.user.oc1..aaaaaaaarsn42gwcl5rvahcmt5r6aheek65z54k5nbd6gtclmqn6emkqxajq")
    CkJsonObject::ckUpdateString(json,"master_key_ocid","ocid1.key.oc1.us-chicago-1.ijttzlz7aadxo.abxyeljtfbqhl5h2velmojmm6ls77lskmc7ardpekjgw264my6fuyxmhm6xa")

    ; Get the binary secret data.
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkSecrets::ckGetSecretBd(secrets,json,bd)
    If success = 0
        Debug CkSecrets::ckLastErrorText(secrets)
        CkSecrets::ckDispose(bootstrap)
        CkJsonObject::ckDispose(bsId)
        CkSecrets::ckDispose(secrets)
        CkJsonObject::ckDispose(json)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    ; For our testing, the binary secret was a JPG image..
    CkBinData::ckWriteFile(bd,"c:/temp/qa_output/starfish.jpg")

    Debug "Success."


    CkSecrets::ckDispose(bootstrap)
    CkJsonObject::ckDispose(bsId)
    CkSecrets::ckDispose(secrets)
    CkJsonObject::ckDispose(json)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure