Skip to content

Commit

Permalink
Merge pull request #3312 from snyk/fix/v2_http_proxy
Browse files Browse the repository at this point in the history 
Fix/v2 http proxy
  • Loading branch information
@PeterSchafer
PeterSchafer authored Jun 21, 2022
2 parents fa2c8aa + 78d0602 commit d3350a1
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 52 deletions.
27 changes: 16 additions & 11 deletions cliv2/internal/cliv2/cliv2.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ const SNYK_EXIT_CODE_ERROR = 2
const SNYK_INTEGRATION_NAME = "CLI_V1_PLUGIN"
const SNYK_INTEGRATION_NAME_ENV = "SNYK_INTEGRATION_NAME"
const SNYK_INTEGRATION_VERSION_ENV = "SNYK_INTEGRATION_VERSION"
const SNYK_HTTPS_PROXY_ENV = "HTTPS_PROXY"
const SNYK_HTTP_PROXY_ENV = "HTTP_PROXY"
const SNYK_CA_CERTIFICATE_LOCATION_ENV = "NODE_EXTRA_CA_CERTS"

const (
V1_DEFAULT Handler = iota
Expand Down Expand Up @@ -137,7 +140,7 @@ func determineHandler(passthroughArgs []string) Handler {
return result
}

func AddIntegrationEnvironment(input []string, name string, version string) (result []string, err error) {
func PrepareV1EnvironmentVariables(input []string, integrationName string, integrationVersion string, proxyAddress string, caCertificateLocation string) (result []string, err error) {

inputAsMap := utils.ToKeyValueMap(input, "=")
result = input
Expand All @@ -146,27 +149,29 @@ func AddIntegrationEnvironment(input []string, name string, version string) (res
_, integrationVersionExists := inputAsMap[SNYK_INTEGRATION_VERSION_ENV]

if !integrationNameExists && !integrationVersionExists {
inputAsMap[SNYK_INTEGRATION_NAME_ENV] = name
inputAsMap[SNYK_INTEGRATION_VERSION_ENV] = version
result = utils.ToSlice(inputAsMap, "=")
inputAsMap[SNYK_INTEGRATION_NAME_ENV] = integrationName
inputAsMap[SNYK_INTEGRATION_VERSION_ENV] = integrationVersion
} else if !(integrationNameExists && integrationVersionExists) {
err = EnvironmentWarning{message: fmt.Sprintf("Partially defined environment, please ensure to provide both %s and %s together!", SNYK_INTEGRATION_NAME_ENV, SNYK_INTEGRATION_VERSION_ENV)}
}

if err == nil {
inputAsMap[SNYK_HTTPS_PROXY_ENV] = proxyAddress
inputAsMap[SNYK_HTTP_PROXY_ENV] = proxyAddress
inputAsMap[SNYK_CA_CERTIFICATE_LOCATION_ENV] = caCertificateLocation
result = utils.ToSlice(inputAsMap, "=")
}

return result, err

}

func PrepareV1Command(cmd string, args []string, proxyPort int, caCertLocation string, integrationName string, integrationVersion string) (snykCmd *exec.Cmd, err error) {

snykCmd = exec.Command(cmd, args...)
snykCmd.Env = append(os.Environ(),
fmt.Sprintf("HTTPS_PROXY=http://127.0.0.1:%d", proxyPort),
fmt.Sprintf("NODE_EXTRA_CA_CERTS=%s", caCertLocation),
)

snykCmd.Env, err = AddIntegrationEnvironment(snykCmd.Env, integrationName, integrationVersion)
proxyAddress := fmt.Sprintf("http://127.0.0.1:%d", proxyPort)

snykCmd = exec.Command(cmd, args...)
snykCmd.Env, err = PrepareV1EnvironmentVariables(os.Environ(), integrationName, integrationVersion, proxyAddress, caCertLocation)
snykCmd.Stdin = os.Stdin
snykCmd.Stdout = os.Stdout
snykCmd.Stderr = os.Stderr
Expand Down
19 changes: 10 additions & 9 deletions cliv2/internal/cliv2/cliv2_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,49 @@
package cliv2_test

import (
"github.com/snyk/cli/cliv2/internal/cliv2"
"io/ioutil"
"log"
"os"
"sort"
"testing"

"github.com/snyk/cli/cliv2/internal/cliv2"

"github.com/stretchr/testify/assert"
)

func Test_addIntegrationEnvironment_Fill(t *testing.T) {
func Test_PrepareV1EnvironmentVariables_Fill(t *testing.T) {

input := []string{"something=1", "in=2", "here=3=2"}
expected := []string{"something=1", "in=2", "here=3=2", "SNYK_INTEGRATION_NAME=foo", "SNYK_INTEGRATION_VERSION=bar"}
expected := []string{"something=1", "in=2", "here=3=2", "SNYK_INTEGRATION_NAME=foo", "SNYK_INTEGRATION_VERSION=bar", "HTTP_PROXY=proxy", "HTTPS_PROXY=proxy", "NODE_EXTRA_CA_CERTS=cacertlocation"}

actual, err := cliv2.AddIntegrationEnvironment(input, "foo", "bar")
actual, err := cliv2.PrepareV1EnvironmentVariables(input, "foo", "bar", "proxy", "cacertlocation")

sort.Strings(expected)
sort.Strings(actual)
assert.Equal(t, expected, actual)
assert.Nil(t, err)
}

func Test_addIntegrationEnvironment_DontOverrideExisting(t *testing.T) {
func Test_PrepareV1EnvironmentVariables_DontOverrideExisting(t *testing.T) {

input := []string{"something=1", "in=2", "here=3", "SNYK_INTEGRATION_NAME=exists", "SNYK_INTEGRATION_VERSION=already"}
input := []string{"something=1", "in=2", "here=3", "SNYK_INTEGRATION_NAME=exists", "SNYK_INTEGRATION_VERSION=already", "HTTP_PROXY=proxy", "HTTPS_PROXY=proxy", "NODE_EXTRA_CA_CERTS=cacertlocation"}
expected := input

actual, err := cliv2.AddIntegrationEnvironment(input, "foo", "bar")
actual, err := cliv2.PrepareV1EnvironmentVariables(input, "foo", "bar", "proxy", "cacertlocation")

sort.Strings(expected)
sort.Strings(actual)
assert.Equal(t, expected, actual)
assert.Nil(t, err)
}

func Test_addIntegrationEnvironment_DontOverrideExisting2(t *testing.T) {
func Test_PrepareV1EnvironmentVariables_DontOverrideExisting2(t *testing.T) {

input := []string{"something=1", "in=2", "here=3", "SNYK_INTEGRATION_NAME=exists"}
expected := input

actual, err := cliv2.AddIntegrationEnvironment(input, "foo", "bar")
actual, err := cliv2.PrepareV1EnvironmentVariables(input, "foo", "bar", "unused", "unused")

sort.Strings(expected)
sort.Strings(actual)
Expand Down
65 changes: 33 additions & 32 deletions test/jest/acceptance/proxy-behavior.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ const SNYK_API_HTTP = 'http://snyk.io/api/v1';
const FAKE_HTTP_PROXY = `http://localhost:${fakeServerPort}`;

jest.setTimeout(1000 * 60 * 1);

describe('Proxy configuration behavior', () => {
describe('*_PROXY against HTTPS host', () => {
it('tries to connect to the HTTPS_PROXY when HTTPS_PROXY is set', async () => {
Expand Down Expand Up @@ -56,41 +55,43 @@ describe('Proxy configuration behavior', () => {
});

describe('*_PROXY against HTTP host', () => {
it('tries to connect to the HTTP_PROXY when HTTP_PROXY is set', async () => {
const { code, stderr } = await runSnykCLI(`woof -d`, {
env: {
...process.env,
HTTP_PROXY: FAKE_HTTP_PROXY,
SNYK_API: SNYK_API_HTTP,
SNYK_HTTP_PROTOCOL_UPGRADE: '0',
},
});
if (!isCLIV2()) {
it('tries to connect to the HTTP_PROXY when HTTP_PROXY is set', async () => {
const { code, stderr } = await runSnykCLI(`woof -d`, {
env: {
...process.env,
HTTP_PROXY: FAKE_HTTP_PROXY,
SNYK_API: SNYK_API_HTTP,
SNYK_HTTP_PROTOCOL_UPGRADE: '0',
},
});

expect(code).toBe(0);
expect(code).toBe(0);

// It will *attempt* to connect to a FAKE_HTTP_PROXY (and fails, because it's not a real proxy server)
expect(stderr).toContain(
`Error: connect ECONNREFUSED 127.0.0.1:${fakeServerPort}`,
);
});

it('does not try to connect to the HTTPS_PROXY when it is set', async () => {
const { code, stderr } = await runSnykCLI(`woof -d`, {
env: {
...process.env,
HTTPS_PROXY: FAKE_HTTP_PROXY,
SNYK_API: SNYK_API_HTTP,
SNYK_HTTP_PROTOCOL_UPGRADE: '0',
},
// It will *attempt* to connect to a FAKE_HTTP_PROXY (and fails, because it's not a real proxy server)
expect(stderr).toContain(
`Error: connect ECONNREFUSED 127.0.0.1:${fakeServerPort}`,
);
});

expect(code).toBe(2);
it('does not try to connect to the HTTPS_PROXY when it is set', async () => {
const { code, stderr } = await runSnykCLI(`woof -d`, {
env: {
...process.env,
HTTPS_PROXY: FAKE_HTTP_PROXY,
SNYK_API: SNYK_API_HTTP,
SNYK_HTTP_PROTOCOL_UPGRADE: '0',
},
});

// Incorrect behavior when Needle tries to upgrade connection after 301 http->https and the Agent option is set to a strict http/s protocol.
// See lines with `keepAlive` in request.ts for more details
expect(stderr).toContain(
'TypeError [ERR_INVALID_PROTOCOL]: Protocol "https:" not supported. Expected "http:"',
);
});
expect(code).toBe(2);

// Incorrect behavior when Needle tries to upgrade connection after 301 http->https and the Agent option is set to a strict http/s protocol.
// See lines with `keepAlive` in request.ts for more details
expect(stderr).toContain(
'TypeError [ERR_INVALID_PROTOCOL]: Protocol "https:" not supported. Expected "http:"',
);
});
}
});
});

0 comments on commit d3350a1

Please sign in to comment.