https://github.com/autodesk-forge/forge-designautomation-signer

This is a utility to sign the parts of the workitem request message with the right algorithm and parameters.
https://github.com/autodesk-forge/forge-designautomation-signer

Last synced: about 6 hours ago
JSON representation

This is a utility to sign the parts of the workitem request message with the right algorithm and parameters.

• Host: GitHub
• URL: https://github.com/autodesk-forge/forge-designautomation-signer
• Owner: Autodesk-Forge
• License: mit
• Created: 2021-07-27T16:34:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T15:45:22.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T12:47:30.175Z (4 days ago)
• Language: PowerShell
• Size: 32.2 MB
• Stars: 1
• Watchers: 10
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Design Automation signer

[![Design-Automation](https://img.shields.io/badge/Design%20Automation-v3-green.svg)](http://developer.autodesk.com/)

![.NET Core](https://img.shields.io/badge/.NET%20Core-5.0-blue.svg)

[![License](http://img.shields.io/:license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

# Description

This is a utility to sign the parts of the workitem request message with the right algorithm and parameters.

# Setup

## Prerequisites

1. [.NET runtime](https://dotnet.microsoft.com/download/dotnet)

## Build

At the folder on the `.csproj`, run the following via command line:

```bash

dotnet publish -r win-x64 -c Release -p:PublishSingleFile=true --self-contained true

```

`Das.WorkItemSigner.exe` can be found under `.\bin\Release\net5.0\win-x64\publish`

## Usage

Download `Das.WorkItemSigner.exe` from [Releases page](https://github.com/Autodesk-Forge/forge-designautomation-signer/releases). 

> **_NOTE:_**  Downloas the stable version of `Das.WorkItemSigner.exe` from the latest release named by `release-main-`; download `Das.WorkItemSigner.exe` for testing from releases named by `debug--`.

- Generate a public/private key pair using Das.WorkitemSigner.

```bash

Das.WorkItemSigner.exe generate mykey.json

```

- Export the public key into a json file using Das.WorkItemSigner.

```bash

Das.WorkItemSigner.exe export mykey.json mypublickey.json

```

- Upload public key using PATCH forgeapps/me API (see https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/forgeapps-id-PATCH/). 

```bash  

  curl forgeapps/me -x PATCH `{'publicKey' : }`

```

- Generate digital signature for the `activityId` that it wants to call using Das.WorkitemSigner

```bash

Das.WorkItemSigner.exe sign mykey.json .PlotToPdf+

```

## Test

- create `setenv.bat`

```

set CLIENT_ID=<>

set CLIENT_SECRET=<>

```

- Create a basic activity, lets name our activity `HelloWorld` with alias `prod`.  Note I'm using `adesk` as forgeapp nickname.

  - ```bash

    {

    	"commandLine": "$(engine.path)\\accoreconsole.exe /s \"$(settings[script].path)\"",

    	"engine": "Autodesk.AutoCAD+24",

    	"settings": {

    		"script": "(print \"Hello World!\")\n"

    	},

    	"description": "Send String To Execute Test",

    	"id": "{{ _.activityId }}"

    }

    ```

  - ```bash

    {

    	"version": 1,

    	"id": "{{ _.alias }}"

    }

    ```

- Or you can run `createActivity.ps1`

```bash

  Das.WorkItemSigner.exe generate mykey.json

  Das.WorkItemSigner.exe export mykey.json mypublickey.json

  .\patchPublicKey.ps1

  Das.WorkItemSigner.exe sign mykey.json adesk.HelloWorld+prod

  .\workitem.ps1

```

## License

This sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.