vsh

vsh

vsh adalah alat cli dan shell HashiCorp Vault yang interaktif. Muncul dengan beberapa operasi umum dan memperlakukan jalur seperti direktori dan file. Fitur inti adalah:

• operasi rekursif pada jalur untuk banyak operasi, misalnya cp , rm , mv
• cari dengan grep (substring atau ekspresi reguler)
• gantikan pola dalam kunci dan/atau nilai (substring atau ekspresi reguler) dengan replace
• transparansi terhadap perbedaan antara KV1 dan KV2, yaitu Anda dapat dengan bebas memindahkan/menyalin rahasia di antara keduanya
• mode non-interaktif untuk otomatisasi ( vsh -c "<cmd>" )
• menggabungkan kunci dengan strategi berbeda melalui append

Instalasi

minuman rumahan

brew install vsh

Nix

nix-env -i vsh

Biner statis untuk Linux / MacOS

Unduh biner statis terbaru dari halaman rilis.

Perintah yang didukung

• add menambahkan satu kunci dan nilai ke jalur
• append menggabungkan rahasia dengan strategi berbeda (memungkinkan operasi rekursif di jalur)
• cat menunjukkan pasangan kunci/nilai dari suatu jalur
• cd memungkinkan navigasi interaktif melalui jalur
• cp menyalin rahasia dari satu lokasi ke lokasi lain (memungkinkan operasi rekursif pada jalur)
• grep mencari substring atau ekspresi reguler (memungkinkan operasi rekursif pada jalur)
• ls menunjukkan subjalur dari jalur tertentu
• mv memindahkan rahasia dari satu lokasi ke lokasi lain (memungkinkan operasi rekursif pada jalur)
• mengganti substring atau ekspresi reguler (memungkinkan operasi rekursif pada jalur)
• rm menghapus rahasia (memungkinkan operasi rekursif pada jalur)

Mengatur token brankas

Untuk mendapatkan token yang valid, vsh menggunakan mekanisme TokenHelper vault. Itu berarti vsh mendukung pengaturan token vault melalui ~/.vault-token , VAULT_TOKEN dan token-helper eksternal.

TLS

Tambahkan sertifikat tls untuk server dengan mengatur variabel lingkungan VAULT_CACERT ke jalur sertifikat pem .

Persyaratan izin token

vsh memerlukan izin List pada jalur yang dioperasikan. Hal ini diperlukan untuk menentukan apakah suatu jalur menunjuk ke sebuah node atau daun di pohon jalur. Selanjutnya, diperlukan untuk mengumpulkan data pelengkapan otomatis.

Perintah yang mengubah data seperti cp atau mv , juga memerlukan izin Read dan Write pada jalur yang dioperasikan.

Untuk menemukan semua backend yang tersedia dengan andal, idealnya token vault yang digunakan oleh vsh memiliki izin List pada sys/mount . Namun, ini bukanlah persyaratan yang sulit. Jika token tidak memiliki izin List pada sys/mount , maka vsh tidak mengetahui backend yang tersedia sebelumnya. Artinya pada awalnya tidak akan ada penyelesaian otomatis jalur di tingkat atas (backend). Apapun itu, vsh akan mencoba dengan strategi upaya terbaik untuk menentukan versi kv dari setiap jalur yang dimasukkan secara andal.

Modus interaktif

 export VAULT_ADDR=http://localhost:8080
export VAULT_TOKEN=root
export VAULT_PATH=secret/  # VAULT_PATH is optional
./vsh
http://localhost:8080 /secret/>

Catatan: token yang diberikan digunakan untuk pelengkapan otomatis, yaitu, kueri List() dilakukan dengan token tersebut, bahkan jika Anda tidak melakukan rm atau mv apa pun. vsh menyimpan cache List() hasil untuk mengurangi jumlah kueri. Namun, setelah eksekusi setiap perintah, cache dibersihkan untuk melakukan penyelesaian tab secara akurat. Jika token Anda memiliki jumlah penggunaan yang terbatas, maka pertimbangkan untuk menggunakan mode non-interaktif atau nonaktifkan pelengkapan otomatis, untuk menghindari kueri List() .

Alihkan penyelesaian otomatis

Untuk mengurangi jumlah kueri terhadap vault, Anda dapat menonaktifkan penyelesaian otomatis jalur dengan 2 cara:

1. Nonaktifkan pada waktu mulai:

 ./vsh --disable-auto-completion

2. Beralih ke dalam mode interaktif:

 ./vsh
http://localhost:8080 /secret/> toggle-auto-completion
Use path auto-completion: false
http://localhost:8080 /secret/> toggle-auto-completion
Use path auto-completion: true

Mode non-interaktif

 export VAULT_ADDR=<addr>
export VAULT_TOKEN=<token>
./vsh -c "rm secret/dir/to/remove/"

Beberapa kata tentang kualitas

Mengerjakan rahasia brankas bisa menjadi hal yang sangat penting, menjadikan perilaku yang berkualitas dan benar sebagai warga negara kelas satu vsh . Meskipun demikian, vsh masih merupakan proyek open source kecil, artinya kami tidak dapat memberikan jaminan apa pun. Namun, kami sangat menekankan pengembangan yang didorong oleh pengujian. Setiap PR diuji dengan serangkaian pengujian integrasi yang ekstensif. Sebagian besar pengujian dijalankan pada KV1 dan KV2 dan setiap pengujian dijalankan terhadap vault 1.13.4 dan 1.16.2 , yaitu versi vault di antaranya kemungkinan juga kompatibel.

️ Secara umum, risiko penggunaan vsh ditanggung oleh Anda sendiri. Kami tidak bertanggung jawab dan tidak memberikan jaminan apa pun.

Kontribusi

Kontribusi dalam bentuk apa pun selalu diterima! Tanpa kontribusi dari komunitas, vsh tidak akan menjadi alat seperti sekarang ini.

Pembangunan Lokal

Persyaratan:

• golang ( >= v1.21 )
• docker untuk pengujian integrasi
• make perintah yang disederhanakan

 make compile
make get-bats
make integration-tests

Men-debug

-v DEBUG menyetel tingkat log debug, yang juga membuat file vsh_trace.log untuk mencatat objek kesalahan apa pun dari API vault.