Pequena biblioteca portátil e incorporável de cliente e servidor SSHv2 em C com SCP, SFTP, encaminhamento de portas e troca de chaves pós-quântica para sistemas embarcados e IoT.
Servidor SSH Embarcável da wolfSSL Manual do wolfSSH
O wolfSSH depende do wolfCrypt, encontrado como parte do wolfSSL. A seguir está a configuração mais simples do wolfSSL para habilitar o wolfSSH.
$ cd wolfssl
$ ./configure [OPTIONS] --enable-ssh
$ make check
$ sudo make install
Em alguns sistemas, o comando opcional ldconfig é necessário após a instalação.
Para usar a função de geração de chaves no wolfSSH, o wolfSSL precisará ser
configurado com keygen: --enable-keygen.
Ao usar certificados X.509 para autenticação de usuário, o wolfSSL deve ser
compilado com TLS habilitado. O wolfSSH usa o sistema de gerenciador de certificados do wolfSSL
para X.509, incluindo consultas OCSP. Para permitir OCSP, adicione --enable-ocsp à
configuração do wolfSSL.
Se a maior parte do código do wolfSSL não for desejada, o wolfSSL pode ser configurado com
a opção somente criptografia: --enable-cryptonly.
Opções adicionais de compilação para o wolfSSL estão localizadas no capítulo dois do manual do wolfSSH.
A partir do diretório de código-fonte do wolfSSH, execute:
$ ./autogen.sh (se clonado do GitHub)
$ ./configure --with-wolfssl=[/usr/local]
$ make
$ make check
O script autogen.sh só precisa ser executado na primeira vez após clonar
o repositório. Se você já o executou ou está usando código de um
arquivo de código-fonte, deve ignorá-lo.
Para compilar no Windows com o Visual Studio, consulte o arquivo "ide/winvs/README.md".
NOTA: Em dispositivos com recursos limitados, o DEFAULT_WINDOW_SZ pode precisar
ser definido com um tamanho menor. Ele também pode ser aumentado em casos de uso em desktop
para ajudar com transferências de arquivos grandes. Por padrão, os canais são definidos para receber
até 128kB de dados antes de enviar uma mensagem de ajuste de janela do canal. Um
exemplo de definição de um tamanho de janela para novos canais seria o seguinte
./configure CPPFLAGS="-DDEFAULT_WINDOW_SZ=16384"
Para plataformas Linux de 32 bits, você pode adicionar suporte para arquivos > 2GB compilando
com CFLAGS=-D_FILE_OFFSET_BITS=64.
O diretório examples contém um echoserver ao qual qualquer cliente deve
conseguir se conectar. A partir do terminal, execute:
$ ./examples/echoserver/echoserver -f
A opção -f habilita o modo somente echo. A partir de outro terminal, execute:
$ ssh jill@localhost -p 22222
Quando solicitada uma senha, digite "upthehill". O servidor enviará um banner predefinido ao cliente:
wolfSSH Example Echo Server
Os caracteres digitados no cliente serão ecoados na tela pelo servidor. Se os caracteres forem ecoados duas vezes, o cliente tem o echo local habilitado. O echoserver não está sendo um terminal adequado, então a tradução CR/LF não funcionará como esperado.
Os seguintes caracteres de controle acionarão ações especiais no echoserver:
Após clonar o repositório, certifique-se de tornar as chaves privadas de teste
somente leitura para o usuário, caso contrário o ssh dirá para você fazer isso.
$ chmod 0600 ./keys/gretel-key-rsa.pem ./keys/hansel-key-rsa.pem \
./keys/gretel-key-ecc.pem ./keys/hansel-key-ecc.pem
A autenticação no echoserver de exemplo pode ser feita com senha ou chave pública. Para usar uma senha, a linha de comando:
$ ssh -p 22222 USER@localhost
Onde os pares USER e senha são:
jill:upthehill
jack:fetchapail
Para usar autenticação por chave pública, use a linha de comando:
$ ssh -i ./keys/USER-key-TYPE.pem -p 22222 USER@localhost
Onde o USER pode ser gretel ou hansel, e TYPE é rsa ou
ecc.
Lembre-se de que o echoserver possui várias contas falsas em sua
função de callback wsUserAuth(). (jack, jill, hansel e gretel) Quando
o suporte a shell está habilitado, essas contas falsas não funcionarão. Elas
não existem no arquivo passwd do sistema. Os usuários serão autenticados,
mas o servidor retornará erro porque eles não existem no sistema. Você
pode adicionar seu próprio nome de usuário à lista de senhas ou chaves públicas no
echoserver. Essa conta será conectada a um shell iniciado pelo
echoserver com os privilégios do usuário que executa o echoserver.
O wolfSSH vem empacotado com algumas ferramentas de exemplo para fins de teste e para demonstrar interoperabilidade com outras implementações de SSH.
O echoserver é a ferramenta principal do wolfSSH. Originalmente, ele só permitia autenticar uma das contas predefinidas e repetia os caracteres digitados nele. Ao habilitar o suporte a shell, ele pode gerar um shell de usuário. Será necessário um nome de usuário real na máquina e uma função de callback de autenticação de usuário atualizada para validar as credenciais. O echoserver também pode lidar com conexões SCP e SFTP.
A ferramenta echoserver aceita as seguintes opções de linha de comando:
-1 sai após uma única (uma) conexão
-e espera chave pública ECC do cliente
-E usa chave privada ECC
-f ecoa a entrada
-p <num> porta para aceitar conexões, padrão 22222
-N usa sockets não bloqueantes
-d <string> define o diretório home para conexões SFTP
-j <file> carrega uma chave pública para aceitar do par
O client estabelece uma conexão com um servidor SSH. Em seu modo mais simples, ele envia a string "Hello, wolfSSH!" para o servidor, imprime a resposta, e então encerra. Com a opção de pseudo terminal, o cliente será um cliente real.
A ferramenta client aceita as seguintes opções de linha de comando:
-h <host> host para conectar, padrão 127.0.0.1
-p <num> porta para conectar, padrão 22222
-u <username> nome de usuário para autenticar (OBRIGATÓRIO)
-P <password> senha para o nome de usuário, solicitada se omitida
-e usa chave ecc de exemplo para o usuário
-i <filename> nome do arquivo para a chave privada do usuário
-j <filename> nome do arquivo para a chave pública do usuário
-x sai após conexão bem-sucedida sem fazer
leitura/escrita
-N usa sockets não bloqueantes
-t usa pseudo terminal
-c <command> executa comando remoto e redireciona stdin/stdout
-a Tenta usar SSH-AGENT
A ferramenta portfwd estabelece uma conexão com um servidor SSH e configura um listener para encaminhamento de porta local ou solicita um listener para encaminhamento de porta remota. Após uma conexão, a ferramenta encerra.
A ferramenta portfwd aceita as seguintes opções de linha de comando:
-h <host> host para conectar, padrão 127.0.0.1
-p <num> porta para conectar, padrão 22222
-u <username> nome de usuário para autenticar (OBRIGATÓRIO)
-P <password> senha para o nome de usuário, solicitada se omitida
-F <host> host de origem do encaminhamento, padrão 0.0.0.0
-f <num> porta do host de origem do encaminhamento (OBRIGATÓRIO)
-T <host> host de destino do encaminhamento, padrão é o host
-t <num> porta de destino do encaminhamento (OBRIGATÓRIO)
O scpclient, wolfscp, estabelece uma conexão com um servidor SSH e copia os arquivos especificados de ou para a máquina local.
A ferramenta scpclient aceita as seguintes opções de linha de comando: