Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
Update lando-corporate-network-tips.md (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
@reynoldsalec
reynoldsalec authored Oct 10, 2024
1 parent 649149a commit 6c822ff
Showing 1 changed file with 59 additions and 65 deletions.
124 changes: 59 additions & 65 deletions guides/lando-corporate-network-tips.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,69 +10,46 @@ Many large organizations have proxy services, SSL decryption, and other network
Depending on your environment's configuration, there is A LOT of variation in setups. This guide offers some tips on common scenarios; it is not comprehensive or prescriptive. When in doubt, talk with your network administrator!
:::

## Defining Proxy Location
## Installing a Proxy Cert

Some proxy setups may require your outbound traffic to leave through a specified port; in these cases you may need to modify your host machine's `HTTP_PROXY`/`HTTPS_PROXY` values:
This is the **top** issue people using Zscaler or other proxy/SSL Decryptors will face. Typically it will show the following errors...

```
export HTTP_PROXY=http://localhost:9000
export HTTPS_PROXY=http://localhost:9000
```

Additionally, you'll want to specify that proxy in your Docker Desktop settings (if running on Windows or Mac). Under Settings > Resources > Proxies, specify...

- Web Server: `http://localhost:9000`
- Secure Web Server: `http://localhost:9000`

...and finally you may need to specify the proxy in the `.lando.yml` file for your project(s):

```
environment:
HTTP_PROXY: "http://host.docker.internal:9000"
HTTPS_PROXY: "http://host.docker.internal:9000"
```

#### Define Proxy Location for `apt-get`

If you use `apt-get` to install packages within a container, you will probably need to define the proxy location for it as well. To do so, modify your project's `.lando.yml` to add the following `build-as-root` command:

```
build_as_root:
- cp /app/.lando/config/apt.conf /etc/apt/apt.conf
Error: unable to get local issuer certificate
```

The `apt.conf` should look like this:

```
Acquire::http::Proxy "http://host.docker.internal:9000";
curl: (60) SSL certificate problem: unable to get local issuer certificate
More details here: http://curl.haxx.se/docs/sslcerts.html
```

Again, configuring the proxy location may not be necessary in your environment.

## SSL Decryption/Missing CA Cert Problems
If you experience a `request to undefined failed with code 200: undefined.` error when running a `lando init` command and trying to connect with a 3rd-party hosting service like Pantheon, this may also be your root issue.

SSL decryption is basically an "authorized" man-in-the-middle attack that is allowed to happen when an intermediate network device (i.e. the SSL decryptor) can intercept all of your requests and pose as the destination server to your local network client. Due to the security precautions in the SSL/TLS protocol, this only works if your network client trusts the certificate that is used by the decryption device. We've most commonly seen SSL Decryption used with ZScaler.
To fix this, you need to install the cert of your proxy/SSL decryptor. The quickest way to fix this is to add your cert to whatever Lando services need access to the external network (ie probably your appserver container). To do this:

If you're missing the cert from your SSL decryptor, you'll likely see one of the following errors like:
1. Retrieve your cert from your network admin or from [your browser](https://medium.com/@menakajain/export-download-ssl-certificate-from-server-site-url-bcfc41ea46a2)
2. Place it in the root of your Lando project.
3. Edit your .lando.yml file to add the following `build_as_root` step to your appserver:

```
Error: unable to get local issuer certificate
```

```
curl: (60) SSL certificate problem: unable to get local issuer certificate
More details here: http://curl.haxx.se/docs/sslcerts.html
services:
appserver:
build_as_root:
- sed 's|mozilla\/AddTrust_External_Root.crt|#mozilla\/AddTrust_External_Root.crt|g' -i /etc/ca-certificates.conf
- cp /app/yourcert.crt /usr/local/share/ca-certificates/
- chmod 644 /usr/local/share/ca-certificates/yourcert.crt
- update-ca-certificates
```

If you experience a `request to undefined failed with code 200: undefined.` error when running a `lando init` command and trying to connect with a 3rd-party hosting service like Pantheon, this may also be your root issue.
### Details on Retrieving Your Cert

Here are the basic steps to enable Lando to work inside such a network environment:
Obtain the certificate(s) of the decryption device in base64 encoded format. Your organization's IT or networking department should be able to provide them to you as they most likely are already importing them into the Windows trusted certificate store so that Windows and other programs like your internet browser will work.

### Retrieve Your Cert
Alternatively, you can export them using your internet browser. Go to any website and click the padlock icon next to the site's URL and inspect the certificate. You should find that it's a custom certificate belonging to your organization's decryption device and not the certificate belonging to the actual website you're visiting.

Obtain the certificate(s) of the decryption device in base64 encoded format. Your organization's IT or networking department should be able to provide them to you as they most likely are already importing them into the Windows trusted certificate store so that Windows and other programs like your internet browser will work. Alternatively, you can export them using your internet browser. Go to any website and click the padlock icon next to the site's URL and inspect the certificate. You should find that it's a custom certificate belonging to your organization's decryption device and not the certificate belonging to the actual website you're visiting. There should be an option to export or save the certificate. View the certification path as there may be more than one certificate you need to export. (In our case, we have a custom root certificate authority as well as an intermediary certificate.)
There should be an option to export or save the certificate. View the certification path as there may be more than one certificate you need to export; for example, in some cases there may be a custom root certificate authority as well as an intermediary certificate.

### Add Cert to Host Environment
## Add Cert to Host Environment

If Lando is experiencing errors before an application is started (IE, before any Docker containers are running for your project), then it's likely that either Node or another service on your host machine doesn't have access to the decryption device's cert.

Expand All @@ -92,7 +69,7 @@ update-ca-certificates

Note the location of the certs may change depending on your Linux distribution.

### Add Cert to Lando
## Add Cert to ALL Lando Services

Lando creates a CA cert on your host environment at `~/.lando/certs/.lndo.site.pem` that is added into all Lando containers. If you replace this cert with your decryptor's CA cert (or whatever chain of certs you think is necessary for your environment), that should resolve ALL downstream certificate issues.

Expand All @@ -106,25 +83,6 @@ Follow these steps:

It's important to wipe out all exisitng Lando containers (hence the uninstall) and make sure to add your cert **BEFORE running any Lando commands** to ensure that your cert is populated into the containers.


### Add Cert to Individual Lando Containers

Once Lando is running, there are a number of cases where code running inside Lando's containers may need to have the certs installed as well. To do this, first **store the certificates somewhere in your Lando project directory.** We just put them in our project's root directory, so within the container the cert is available at `/app/yourcert.crt`.

#### Adding Certs to an Appserver Container

Add this to your project's `.lando.yml`, replacing `yourcert.crt` with the name of your certificates:

```
services:
appserver:
build_as_root:
- sed 's|mozilla\/AddTrust_External_Root.crt|#mozilla\/AddTrust_External_Root.crt|g' -i /etc/ca-certificates.conf
- cp /app/yourcert.crt /usr/local/share/ca-certificates/
- chmod 644 /usr/local/share/ca-certificates/yourcert.crt
- update-ca-certificates
```

#### Adding Certs for PHP cURL Requests
If you make external requests with the PHP process in your app, you will also need to include the cert in your appserver's `php.ini` file:

Expand Down Expand Up @@ -186,8 +144,44 @@ cacert /app/yourcert.crt
proxy http://host.docker.internal:9000
```

## Defining Proxy Location

Some proxy setups may require your outbound traffic to leave through a specified port; in these cases you may need to modify your host machine's `HTTP_PROXY`/`HTTPS_PROXY` values:

```
export HTTP_PROXY=http://localhost:9000
export HTTPS_PROXY=http://localhost:9000
```

Additionally, you'll want to specify that proxy in your Docker Desktop settings (if running on Windows or Mac). Under Settings > Resources > Proxies, specify...

- Web Server: `http://localhost:9000`
- Secure Web Server: `http://localhost:9000`

...and finally you may need to specify the proxy in the `.lando.yml` file for your project(s):

```
environment:
HTTP_PROXY: "http://host.docker.internal:9000"
HTTPS_PROXY: "http://host.docker.internal:9000"
```

#### Define Proxy Location for `apt-get`

If you use `apt-get` to install packages within a container, you will probably need to define the proxy location for it as well. To do so, modify your project's `.lando.yml` to add the following `build-as-root` command:

```
build_as_root:
- cp /app/.lando/config/apt.conf /etc/apt/apt.conf
```

The `apt.conf` should look like this:

```
Acquire::http::Proxy "http://host.docker.internal:9000";
```

Again, configuring the proxy location may not be necessary in your environment.

Finally, run `lando rebuild` to rebuild all of the services you added the certs. Hopefully you should be able to access the internet through your network decryption device!

0 comments on commit 6c822ff

Please sign in to comment.