Enable referencing links from non-public sources

[pauleHeisster]

Question

I am trying to use an include from a source within a GitHub enterprise repo.

Is ist possible to pass credentials for authorization?! As a workaround I am using autogenerated tokens from the raw content of these references, but I would like to get rid of them.

[simonbrowndotje]

The DSL !include?

[pauleHeisster]

That‘s right. I am using the structurizr/lite image and added our self-signed certs already but hasn‘t found an option for providing credentials.

[simonbrowndotje]

See #134 for an existing discussion of this.

[trcooke]

Hi Simon,

This is something I'm currently wrangling with too. Referencing dsl files in private repos to enable us to keep architecture diagram files next to the code they illustrate.

Given that this DSL is open source would you be open to a PR to add support for this? In my case I'm using BitBucket and auth is provided in a header, so I would be proposing an extension to the DSL to accept headers, and extend the !include dsl to accept URLs and headers as String so that string substitution could be employed to read auth info from environment variables. Something like this:

!include https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/myfile.dsl 'Authorization: Basic ${AUTH_TOKEN}'

where AUTH_TOKEN is an environment variable.

Cheers, Tim

[simonbrowndotje]

would you be open to a PR to add support for this

Not really, but thanks for asking first!

[trcooke]

fair enough

[simonbrowndotje]

I'd recommend the approach described at #134 (comment) ... i.e. bulid yourself a script/plugin to download the protected resource, then use !include as normal. For example:

workspace {
  model {
    ...
    !plugin DownloadProtectedFilePlugin https://company.github.com/repo/file.dsl
    !include file.dsl
  }
}

The reason I don't want to add support for authentication is that I'll end up supporting every combination of basic auth, OAuth, SSL certs, proxy servers, etc ... and I don't have the time for that I'm afraid.

[trcooke]

I'll end up supporting every combination

Yes I could see how that might turn into a journey with no end. You're wise to avoid it.

Thanks for the plugin/script recommendation. I'll pursue that approach.