informatiquecdc.win_authorized_key

win_authorized_key - Dodaje lub usuwa klucz SSH autoryzowany

Zarys

Moduł Ansible do dodawania lub usuwania kluczy SSH autoryzowanych dla konkretnych kont użytkowników w systemach Windows.

Wymagania

Poniższe wymagania muszą być spełnione na hoście, który wykonuje ten moduł.

Win32 OpenSSH

Parametry

Parametr	Wybory/Domyślne	Uwagi
user string / wymagane		Nazwa użytkownika na zdalnym hoście, którego plik authorized_keys zostanie zmodyfikowany
key string / wymagane		Klucz publiczny SSH jako string lub (od wersji 1.9) URL https://github.com/nazwa_użytkownika.keys
path string	Domyślne: (domowy_katalog)+/.ssh/authorized_keys	Alternatywna ścieżka do pliku authorized_keys
manage_dir boolean	Wybory: nie tak ←	Czy ten moduł powinien zarządzać katalogiem pliku kluczy autoryzowanych. Jeśli ustawione, moduł utworzy katalog oraz ustawi właściciela i uprawnienia istniejącego katalogu. Upewnij się, że ustawiasz manage_dir=`nie`, jeśli używasz alternatywnego katalogu dla authorized_keys, jak ustawione w `path`, ponieważ możesz zablokować sobie dostęp SSH. Zobacz przykład poniżej.
state string	Wybory: obecny ← nieobecny	Czy dany klucz (z danymi opcjami klucza) powinien znajdować się lub nie w pliku
key_options string		Łańcuch opcji klucza SSH, który ma być dodany do klucza w pliku authorized_keys
exclusive boolean	Wybory: nie ← tak	Czy usunąć wszystkie inne nieokreślone klucze z pliku authorized_keys. Kilka kluczy można określić w jednej wartości key, oddzielając je nowymi liniami. Ta opcja nie jest świadoma pętli, więc jeśli używasz `with_`, będzie wyłączna dla każdej iteracji pętli, jeśli chcesz mieć wiele kluczy w pliku, musisz przekazać je wszystkie do `key` w jednej partii, jak wspomniano powyżej.
validate_certs boolean	Wybory: nie tak ←	To dotyczy tylko, gdy używasz URL https jako źródła kluczy. Jeśli ustawione na `nie`, certyfikaty SSL nie będą weryfikowane. To powinno być tylko ustawione na `nie`, gdy jest używane na stronach osobiście kontrolowanych z certyfikatami self-signed, aby uniknąć weryfikacji źródłowej strony.
comment string		Zmień komentarz w publicznym kluczu. Zmiana komentarza jest użyteczna w przypadkach takich jak pobieranie go z GitHub lub GitLab. Jeśli żaden komentarz nie jest określony, istniejący komentarz zostanie zachowany.
follow boolean	Wybory: nie ← tak	Podążaj za ścieżką linku symbolicznego zamiast go zastępować

Przykłady

---
roles:
  - win_authorized_key

tasks:

  - name: Ustaw klucz autoryzowany pobrany z pliku
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"

  - name: Ustaw klucze autoryzowane pobrane z URL
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/charlie.keys

  - name: Ustaw klucz autoryzowany w alternatywnej lokalizacji
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      path: c:/ProgramData/ssh/administrators_authorized_key
      manage_dir: False

  - name: Ustaw wiele kluczy autoryzowanych
    win_authorized_key:
      user: deploy
      state: present
      key: '{{ item }}'
    with_file:
      - public_keys/doe-jane
      - public_keys/doe-john

  - name: Ustaw klucz autoryzowany definiując opcje klucza
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      key_options: 'no-port-forwarding,from="10.0.1.1"'

  - name: Ustaw klucz autoryzowany bez weryfikacji certyfikatów TLS/SSL
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/user.keys
      validate_certs: False

  - name: Ustaw klucz autoryzowany, usuwając wszystkie już ustawione klucze
    win_authorized_key:
      user: administrator
      key: '{{ item }}'
      state: present
      exclusive: True
    with_file:
      - public_keys/doe-jane

Wartości zwracane

Ogólne wartości zwracane są opisane tutaj, poniżej znajdują się pola unikalne dla tego modułu:

Klucz	Zwracane	Opis
exclusive boolean	sukces	Czy klucz został wymuszenie oznaczony jako wyłączny. Przykład: False
key string	sukces	Klucz, z którym moduł był używany. Przykład: https://github.com/user.keys
key_option string	sukces	Opcje klucza związane z kluczem.
keyfile string	sukces	Ścieżka do pliku klucza autoryzowanego. Przykład: C:/users/charlie/.ssh/authorized_keys
manage_dir boolean	sukces	Czy ten moduł zarządzał katalogiem pliku klucza autoryzowanego. Przykład: True
path string	sukces	Alternatywna ścieżka do pliku authorized_keys.
state string	sukces	Czy dany klucz (z danymi opcjami klucza) powinien znajdować się lub nie w pliku. Przykład: obecny
unique boolean	sukces	Czy klucz jest unikalny. Przykład: False
user string	sukces	Nazwa użytkownika na zdalnym hoście, którego plik authorized_keys zostanie zmodyfikowany. Przykład: użytkownik
validate_certs boolean	sukces	Dotyczy tylko, gdy używasz URL https jako źródła kluczy. Jeśli ustawione na `nie`, certyfikaty SSL nie będą weryfikowane. Przykład: True