Esta página foi traduzida pela API Cloud Translation.

Configurar o mTLS da Apigee

Depois de instalar o mTLS do Apigee em todos os nós do cluster, configure e inicialize o componente apigee-mtls. Para fazer isso, gere um par de certificado/chave e atualize o arquivo de configuração na máquina de administração. Em seguida, implante os mesmos arquivos gerados e o arquivo de configuração em todos os nós do cluster e inicialize o componente apigee-mtls local.

Configurar apigee-mtls (após a instalação inicial)

Esta seção descreve como configurar o mTLS da Apigee diretamente após a instalação inicial. Para saber como atualizar uma instalação atual do mTLS da Apigee, consulte Mudar uma configuração de apigee-mtls.

Esta seção se aplica a instalações em um único data center. Para informações sobre como configurar o mTLS da Apigee em uma configuração de vários data centers, consulte Configurar vários data centers para o mTLS da Apigee.

O processo geral para configurar apigee-mtls é o seguinte:

Atualizar o arquivo de configuração:na máquina de administração, atualize o arquivo de configuração para incluir as configurações apigee-mtls.
Instalar o Consul e gerar credenciais:instale o Consul e, opcionalmente, use-o para gerar credenciais TLS (somente uma vez).
Além disso, edite o arquivo de configuração do mTLS do Apigee para:
1. Adicionar as informações das credenciais
2. Definir a topologia do cluster
É possível usar suas credenciais atuais ou gerá-las com o Consul.
Distribua as credenciais e o arquivo de configuração:Distribua o mesmo par de certificado/chave gerado e o arquivo de configuração atualizado para todos os nós do cluster.
Inicializar apigee-mtls:inicialize o componente apigee-mtls em cada nó.

Cada uma dessas etapas é descrita nas seções a seguir.

Etapa 1: atualizar o arquivo de configuração

Esta seção descreve como modificar o arquivo de configuração para incluir propriedades de configuração de mTLS. Para informações mais gerais sobre o arquivo de configuração, consulte Como criar um arquivo de configuração.

Depois de atualizar o arquivo de configuração com as propriedades relacionadas ao mTLS, copie-o para todos os nós do cluster antes de inicializar o componente apigee-mtls nesses nós.

Atenção:não inclua os endereços IP de componentes que não exigem mTLS, como servidores de interface do Edge, na propriedade ALL_IP. A inclusão de endereços IP desnecessários pode causar problemas durante a instalação do componente apigee-mtls.

Para atualizar o arquivo de configuração:

Na máquina de administração, abra o arquivo de configuração para edição.

Copie o seguinte conjunto de propriedades de configuração de mTLS e cole no arquivo de configuração:

ALL_IP="ALL_PRIVATE_IPS_IN_CLUSTER"
ZK_MTLS_HOSTS="ZOOKEEPER_PRIVATE_IPS"
CASS_MTLS_HOSTS="CASSANDRA_PRIVATE_IPS"
PG_MTLS_HOSTS="POSTGRES_PRIVATE_IPS"
RT_MTLS_HOSTS="ROUTER_PRIVATE_IPS"
MS_MTLS_HOSTS="MGMT_SERVER_PRIVATE_IPS"
MP_MTLS_HOSTS="MESSAGE_PROCESSOR_PRIVATE_IPS"
QP_MTLS_HOSTS="QPID_PRIVATE_IPS"
LDAP_MTLS_HOSTS="OPENLDAP_PRIVATE_IPS"
MTLS_ENCAPSULATE_LDAP="y"

ENABLE_SIDECAR_PROXY="y"
ENCRYPT_DATA="BASE64_GOSSIP_MESSAGE"
PATH_TO_CA_CERT="PATH/TO/consul-agent-ca.pem"
PATH_TO_CA_KEY="PATH/TO/consul-agent-ca-key.pem"
APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR="NUMBER_OF_DAYS"

Defina o valor de cada propriedade para alinhar com a configuração.

A tabela a seguir descreve essas propriedades de configuração:

Propriedade	Descrição
`ALL_IP`	Uma lista separada por espaços dos endereços IP de host particulares de todos os nós no cluster. A ordem dos endereços IP não importa, exceto que ela precisa ser a mesma em todos os arquivos de configuração do cluster. Se você configurar o mTLS da Apigee para vários data centers, liste todos os endereços IP de todos os hosts em todas as regiões.
`LDAP_MTLS_HOSTS`	O endereço IP do host particular do nó do OpenLDAP no cluster.
`ZK_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os nós do ZooKeeper são hospedados no cluster. Com base nos requisitos, é necessário ter pelo menos três nós do ZooKeeper.
`CASS_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os servidores do Cassandra são hospedados no cluster.
`PG_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os servidores Postgres são hospedados no cluster.
`RT_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os roteadores são hospedados no cluster.
`MTLS_ENCAPSULATE_LDAP`	Criptografa o tráfego LDAP entre o processador de mensagens e o servidor LDAP. Defina como `y`.
`MS_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os nós do servidor de gerenciamento são hospedados no cluster.
`MP_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os processadores de mensagens são hospedados no cluster.
`QP_MTLS_HOSTS`	Uma lista separada por espaços de endereços IP de host particulares em que os servidores Qpid são hospedados no cluster.
`ENABLE_SIDECAR_PROXY`	Determina se o Cassandra e o Postgres precisam estar cientes da malha de serviço. Defina esse valor como "y".
`ENCRYPT_DATA`	A chave de criptografia codificada em base64 usada pelo Consul. Você gerou essa chave usando o comando `consul keygen` na Etapa 2: instalar o Consul e gerar credenciais. Esse valor precisa ser o mesmo em todos os nós do cluster.
`PATH_TO_CA_CERT`	O local do arquivo de certificado no nó. Você gerou esse arquivo na Etapa 2: instalar o Consul e gerar credenciais. Esse local precisa ser o mesmo em todos os nós do cluster para que os arquivos de configuração sejam iguais. O certificado precisa ser codificado em X509v3.
`PATH_TO_CA_KEY`	O local do arquivo de chave no nó. Você gerou esse arquivo na Etapa 2: instalar o Consul e gerar credenciais. Esse local precisa ser o mesmo em todos os nós do cluster para que os arquivos de configuração sejam iguais. O arquivo de chave precisa ser codificado em X509v3.
`APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR`	O número de dias de validade de um certificado quando você gera um certificado personalizado. O valor padrão é 365. O valor máximo é de 7.865 dias (cinco anos).

Além das propriedades listadas acima, o mTLS do Apigee usa várias outras propriedades quando é instalado em uma configuração de vários data centers. Para mais informações, consulte Configurar vários data centers.

Verifique se ENABLE_SIDECAR_PROXY está definido como "y".
Atualize os endereços IP nas propriedades relacionadas ao host. Use os endereços IP privados ao se referir a cada nó, não os endereços IP públicos.
Nas etapas seguintes, você vai definir os valores das outras propriedades, como ENCRYPT_DATA, PATH_TO_CA_CERT e PATH_TO_CA_KEY. Você ainda não definiu os valores.

Ao editar as propriedades de configuração apigee-mtls, observe o seguinte:
- Todas as propriedades são strings. É necessário envolver os valores de todas as propriedades em aspas simples ou duplas.
- Se um valor relacionado ao host tiver mais de um endereço IP privado, separe cada endereço IP com um espaço.
- Use endereços IP privados, e não nomes de host ou endereços IP públicos, para todas as propriedades relacionadas ao host no arquivo de configuração.
- A ordem dos endereços IP em um valor de propriedade precisa ser a mesma em todos os arquivos de configuração do cluster.
Salve suas alterações no arquivo de configuração.

Etapa 2: instalar o Consul e gerar credenciais

Esta seção descreve como instalar o Consul e gerar as credenciais usadas pelos componentes ativados para mTLS.

Escolha um dos seguintes métodos para gerar suas credenciais:

(Recomendado) Crie sua própria autoridade certificadora (AC) usando o Consul, conforme descrito nesta seção
Usar as credenciais de uma AC com o mTLS do Apigee (avançado)

Sobre as credenciais

As credenciais consistem no seguinte:

Certificado:o certificado TLS.
Chave:a chave pública do TLS.
Mensagem de boato:uma chave de criptografia codificada em base64.

Você gera uma única versão de cada um desses arquivos apenas uma vez. Em seguida, copie os arquivos de chave e certificado para todos os nós do cluster e adicione a chave de criptografia ao arquivo de configuração, que também será copiado para todos os nós.

Para mais informações sobre a implementação de criptografia do Consul, consulte:

Instalar o Consul e gerar credenciais

Para gerar credenciais que o mTLS da Apigee usa para autenticar comunicações seguras entre os nós no cluster de nuvem privada, use um binário Consul local . Como resultado, é necessário instalar o Consul na máquina de administração antes de gerar credenciais.

Para instalar o Consul e gerar credenciais mTLS:

Na máquina de administração, faça o download do binário do Consul 1.8.0 no site da HashiCorp (em inglês).
Extraia o conteúdo do arquivo salvo. Por exemplo, extraia o conteúdo para /opt/consul/.
OBSERVAÇÃO:continue com este procedimento para usar o Consul para gerar as credenciais (recomendado). Se você quiser usar suas credenciais atuais, consulte Integrar certificados personalizados com o mTLS do Apigee (avançado).
Na máquina de administração, crie uma nova autoridade certificadora (CA) executando o seguinte comando:
```
/opt/consul/consul tls ca create
```
O Consul cria os arquivos a seguir, que formam um par de certificado/chave:
- consul-agent-ca.pem (certificado)
- consul-agent-ca-key.pem (chave)
Por padrão, os arquivos de certificado e chave são codificados em X509v3.

Mais tarde, você vai copiar esses arquivos para todos os nós do cluster. No momento, no entanto, você só precisa decidir onde colocar esses arquivos nos nós. Eles precisam estar no mesmo local em cada nó. Por exemplo, /opt/apigee/.
No arquivo de configuração, defina o valor de PATH_TO_CA_CERT como o local para copiar o arquivo consul-agent-ca.pem no nó. Exemplo:
```
PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
```
Defina o valor de PATH_TO_CA_KEY como o local para onde você vai copiar o arquivo consul-agent-ca-key.pem no nó. Exemplo:
```
PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
```
Crie uma chave de criptografia para o Consul executando o seguinte comando:
```
/opt/consul/consul keygen
```
O Consul gera uma string aleatória semelhante a esta:
```
QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY=
```
Copie essa string gerada e defina-a como o valor da propriedade ENCRYPT_DATA no arquivo de configuração. Exemplo:
```
ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
```
OBSERVAÇÃO:o valor acima é uma chave de criptografia de exemplo. Ela não é a string que você vai usar. Você precisa gerar o seu próprio.
Salve o arquivo de configuração.

O exemplo a seguir mostra as configurações relacionadas ao mTLS em um arquivo de configuração (com valores de exemplo):

...
IP1=10.126.0.121
IP2=10.126.0.124
IP3=10.126.0.125
IP4=10.126.0.127
IP5=10.126.0.130
ALL_IP="$IP1 $IP2 $IP3 $IP4 $IP5"
LDAP_MTLS_HOSTS="$IP3"
ZK_MTLS_HOSTS="$IP3 $IP4 $IP5"
CASS_MTLS_HOSTS="$IP3 $IP4 $IP5"
PG_MTLS_HOSTS="$IP2 $IP1"
RT_MTLS_HOSTS="$IP4 $IP5"
MS_MTLS_HOSTS="$IP3"
MP_MTLS_HOSTS="$IP4 $IP5"
QP_MTLS_HOSTS="$IP2 $IP1"
ENABLE_SIDECAR_PROXY="y"
ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
...

Etapa 3: distribuir o arquivo de configuração e as credenciais

Copie os seguintes arquivos para todos os nós usando uma ferramenta como scp:

Arquivo de configuração:copie a versão atualizada desse arquivo e substitua a versão atual em todos os nós, não apenas nos que executam o ZooKeeper.
consul-agent-ca.pem::copie para o local especificado como o valor de PATH_TO_CA_CERT no arquivo de configuração.
consul-agent-ca-key.pem::copie para o local especificado como o valor de PATH_TO_CA_KEY no arquivo de configuração.

Verifique se os locais para onde você copia os arquivos de certificado e chave correspondem aos valores definidos no arquivo de configuração na Etapa 2: instalar o Consul e gerar credenciais.

Etapa 4: inicializar a apigee-mtls

Depois de instalar o apigee-mtls em cada nó, atualizar o arquivo de configuração e copiar as credenciais para todos os nós no cluster, você estará pronto para inicializar o componente apigee-mtls em cada nó.

Para inicializar a apigee-mtls:

Faça login em um nó do cluster como usuário raiz. É possível realizar essas etapas nos nós em qualquer ordem.
Torne o usuário apigee:apigee proprietário do arquivo de configuração atualizado, conforme mostrado no exemplo abaixo:
```
chown apigee:apigee config_file
```

Configure o componente apigee-mtls executando o seguinte comando:

/opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f config_file

(Opcional) Execute o seguinte comando para verificar se a configuração foi concluída:
```
/opt/apigee/apigee-mtls/lib/actions/iptables.sh validate
```
Inicie o Apigee mTLS executando o seguinte comando:
```
/opt/apigee/apigee-service/bin/apigee-service apigee-mtls start
```
Depois de instalar o mTLS do Apigee, é necessário iniciar esse componente antes de qualquer outro componente no nó.

(somente nós do Cassandra) O Cassandra exige argumentos adicionais para funcionar na malha de segurança. Como resultado, é necessário executar os seguintes comandos em cada nó do Cassandra:

/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra setup -f config_file
/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart

(Somente nós do Postgres) O Postgres exige argumentos adicionais para funcionar na camada de segurança. Como resultado, faça o seguinte nos nós do Postgres:
(somente principal)
1. Execute os seguintes comandos no nó principal do Postgres:
```
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql setup -f config_file
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql configure
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql restart
```
(Somente em modo de espera)
1. Faça backup dos seus dados do Postgres. Para instalar o mTLS do Apigee, é necessário inicializar novamente os nós principais/de reserva, o que vai resultar em perda de dados. Para mais informações, consulte Configurar a replicação primária/de reserva para Postgres.
2. Exclua todos os dados do Postgres:
```
rm -rf /opt/apigee/data/apigee-postgresql/pgdata
```
3. Configure e reinicie o Postgres, conforme mostrado no exemplo a seguir:
```
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql setup -f config_file
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql configure
/opt/apigee/apigee-service/bin/apigee-service apigee-postgresql restart
```
OBSERVAÇÃO:devido a problemas de rede, talvez seja necessário executar esta etapa mais de uma vez para que ela seja concluída.

Se você estiver instalando em uma topologia de vários data centers, use um caminho absoluto para o arquivo de configuração.
Inicie os componentes restantes da Apigee no nó na ordem de início, conforme mostrado no exemplo abaixo:
```
/opt/apigee/apigee-service/bin/apigee-service component_name start
```
Repita esse processo para cada nó no cluster.
(Opcional) Verifique se a inicialização da apigee-mtls foi concluída usando um ou mais dos seguintes métodos:
1. Validar a configuração do iptables
2. Verificar o status do proxy remoto
3. Verificar o status do quórum
Cada um desses métodos é descrito em Verificar a configuração.

Mudar uma configuração de apigee-mtls

Para personalizar uma configuração apigee-mtls, desinstale e reinstale o apigee-mtls. Também é necessário aplicar a personalização em todos os nós.

CUIDADO:a configuração e a configuração do mTLS da Apigee não são idempotentes. Como resultado, as entradas de configuração apigee-mtls precisam ser idênticas em todos os nós: se você fizer uma mudança em um nó, precisará fazer a mesma mudança em todos os nós. Caso contrário, a malha de serviços pode falhar.

Para reiterar esse ponto, ao mudar uma configuração de mTLS da Apigee:

Se você mudar um arquivo de configuração, primeiro desinstale apigee-mtls e execute novamente setup ou configure:

# DO THIS:
/opt/apigee/apigee-service/bin/apigee-service apigee-mtls uninstall

# BEFORE YOU DO THIS:
/opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f file
OR
/opt/apigee/apigee-service/bin/apigee-service apigee-mtls configure

Desinstale e execute novamente setup ou configure em todos os nós do cluster, não apenas em um único nó.

OBSERVAÇÃO:executar setup ou configure repetidamente no apigee-mtls não funciona da mesma forma que outros serviços da Apigee. Ele não gera necessariamente uma nova configuração nem modifica a configuração local. Portanto, é necessário desinstalar o mTLS quando você mudar a configuração.