Add buffer clean in Huawei session preparation

.github/workflows/main_testing.yaml

@@ -52,7 +52,7 @@ jobs:
         shell: bash
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11', "3.12", "3.13.0-beta.2" ]
+        python-version: [ '3.9', '3.10', '3.11', "3.12", "3.13" ]
         platform: [ubuntu-24.04, windows-2022]
 
     runs-on: ${{ matrix.platform }}
@@ -96,7 +96,7 @@ jobs:
         shell: bash
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
+        python-version: [ '3.9', '3.10', '3.11' ]
         platform: [macos-13]
 
     runs-on: ${{ matrix.platform }}

ENCRYPTION_HANDLING.md

@@ -0,0 +1,148 @@
+# Netmiko Encryption Handling
+
+This document describes the encryption mechanisms available in Netmiko for handling sensitive data in configuration files. These mechanisms are generally intended for use with `~/.netmiko.yml` and Netmiko Tools.
+
+## Overview
+
+Netmiko provides built-in encryption capabilities to secure sensitive data (like passwords) in your Netmiko Tools YAML configuration files. The encryption system is flexible and supports multiple encryption types.
+
+## Configuration
+
+### Basic Setup
+
+Encryption is configured in the `~/.netmiko.yml` file using the `__meta__` field:
+
+```yaml
+__meta__:
+  encryption: true
+  encryption_type: fernet  # or aes128
+```
+
+The two supported encryption types are:
+- `fernet` (recommended)
+- `aes128`
+
+### Encryption Key
+
+The encryption key is read from the environment variable `NETMIKO_TOOLS_KEY`. This should be a secure, randomly-generated key appropriate for the chosen encryption type.
+
+```bash
+# Example of setting the encryption key
+export NETMIKO_TOOLS_KEY="your-secure-key-here"
+```
+
+## Using Encryption
+
+### Encrypted Values in YAML
+
+When encryption is enabled, Netmiko looks for fields that start with `__encrypt__`. For example:
+
+```yaml
+arista1:
+  device_type: arista_eos
+  host: arista1.domain.com
+  username: pyclass
+  password: >
+    __encrypt__ifcs7SWOUER4m1K3ZEZYlw==:Z0FBQUFBQm5CQ9lrdV9BVS0xOWxYelF1Yml
+    zV3hBcnF4am1SWjRYNnVSRGdBb1FPVmJ2Q2EzX1RjTWxYMVVMdlBZSXVqYWVqUVNASXNRO
+    FBpR1MxRTkxN2J0NWxVeZNKT0E9PQ==
+```
+
+### Encryption Functions
+
+#### Encrypting Values
+
+To encrypt a value, use the `encrypt_value` function:
+
+```python
+def encrypt_value(value: str, key: bytes, encryption_type: str) -> str:
+    """
+    Encrypt a value using the specified encryption type.
+
+    Args:
+        value: The string to encrypt
+        key: Encryption key as bytes
+        encryption_type: Either 'fernet' or 'aes128'
+
+    Returns:
+        Encrypted string with '__encrypt__' prefix
+    """
+```
+
+#### Decrypting Values
+
+To decrypt a value, use the `decrypt_value` function:
+
+```python
+def decrypt_value(encrypted_value: str, key: bytes, encryption_type: str) -> str:
+    """
+    Decrypt a value using the specified encryption type.
+
+    Args:
+        encrypted_value: The encrypted string (including '__encrypt__' prefix)
+        key: Encryption key as bytes
+        encryption_type: Either 'fernet' or 'aes128'
+
+    Returns:
+        Decrypted string
+    """
+```
+
+#### Getting the Encryption Key
+
+To retrieve the encryption key from the environment:
+
+```python
+def get_encryption_key() -> bytes:
+    """
+    Retrieve the encryption key from NETMIKO_TOOLS_KEY environment variable.
+
+    Returns:
+        Encryption key as bytes
+    """
+```
+
+## Example Usage
+
+Here's a complete example of how to use encryption in your code:
+
+```python
+from netmiko.encryption_handling import encrypt_value, get_encryption_key
+from netmiko.encryption_handling import decrypt_value
+
+# Get the encryption key from environment
+key = get_encryption_key()
+
+# Encrypt a password
+password = "my_secure_password"
+encrypted_password = encrypt_value(password, key, "fernet")
+
+# The encrypted password can now be stored in your YAML file
+# It will automatically be decrypted when Netmiko Tools reads the 
+# file (assuming you have properly set the '__meta__' fields
+```
+
+Alternatively, you can decrypt the value by calling
+
+```python
+clear_value = decrypt_value(encrypted_value, key, encryption_type="fernet)
+```
+
+Or you can create a simple function to decrypt all of the fields in the YAML
+file dynamically (by looking for any fields that start with `__encrypt__`).
+
+Netmiko's 'encryption_handling.py' implements this using the 'decrypt_config'
+function, but this function is a specific to Netmiko Tools' .netmiko.yml format 
+(i.e. it will need modified if you want to use it in a more generic context).
+
+## Implementation Notes
+
+1. Encryption is processed transparently when Netmiko Tools reads the YAML file
+2. Only fields prefixed with `__encrypt__` are processed for decryption
+3. The encryption type is determined by the `__meta__` section
+
+## Security Considerations
+
+1. Store the `NETMIKO_TOOLS_KEY` securely and never commit it to version control
+2. Fernet encryption is recommended over AES128 as it includes additional security features
+3. Encrypted values in YAML files should still be treated as sensitive data

PLATFORMS.md

@@ -73,13 +73,15 @@
 
 - A10
 - Accedian
+- Alaxala AX2600S and AX3600S 
 - Allied Telesis AlliedWare Plus
 - Aruba OS (Wireless Controllers/WAPs)
 - Aruba AOS-CX
 - Brocade Fabric OS
 - C-DOT CROS
 - Ciena SAOS
 - Citrix Netscaler
+- Cisco APIC (Linux)
 - Cisco Telepresence
 - Cisco Viptela
 - Check Point GAiA
@@ -96,16 +98,20 @@
 - F5 TMSH
 - F5 Linux
 - Fortinet
+- Garderos GRS
+- Genexis Saturn SOLT33 (telnet only)
 - MRV Communications OptiSwitch
 - MRV LX
 - Nokia/Alcatel SR-OS
 - Nokia SR Linux
+- Optilink EOLT 9702 (telnet only)
 - QuantaMesh
 - Rad ETX
 - Raisecom ROAP
 - Sophos SFOS
 - Ubiquiti Unifi Switch
 - Versa Networks FlexVNF
+- Vertiv MPH Power Distribution Units
 - Watchguard Firebox
 - Zyxel NOS
 - 6WIND TurboRouter
@@ -117,12 +123,15 @@
 - adtran_os
 - adva_fsp150f2
 - adva_fsp150f3
+- alaxala_ax26s
+- alaxala_ax36s
 - alcatel_aos
 - alcatel_sros
 - allied_telesis_awplus
 - apresia_aeos
 - arista_eos
 - arris_cer
+- aruba_aoscx
 - aruba_os
 - aruba_osswitch
 - aruba_procurve
@@ -144,6 +153,7 @@
 - centec_os
 - checkpoint_gaia
 - ciena_saos
+- cisco_apic
 - cisco_asa
 - cisco_ftd
 - cisco_ios
@@ -165,8 +175,8 @@
 - dell_os9
 - dell_powerconnect
 - dell_sonic
-- dlink_ds
 - digi_transport
+- dlink_ds
 - eltex
 - eltex_esr
 - endace
@@ -187,8 +197,10 @@
 - f5_linux
 - f5_ltm
 - f5_tmsh
+- fiberstore_fsos
 - flexvnf
 - fortinet
+- garderos_grs
 - generic
 - generic_termserver
 - hillstone_stoneos
@@ -206,6 +218,7 @@
 - keymile
 - keymile_nos
 - linux
+- maipu
 - mellanox
 - mellanox_mlnxos
 - mikrotik_routeros
@@ -235,6 +248,7 @@
 - ubiquiti_edgerouter
 - ubiquiti_edgeswitch
 - ubiquiti_unifiswitch
+- vertiv_mph
 - vyatta_vyos
 - vyos
 - watchguard_fireware
@@ -248,34 +262,37 @@
 - apresia_aeos_telnet
 - arista_eos_telnet
 - aruba_procurve_telnet
-- audiocode_72_telnet
 - audiocode_66_telnet
+- audiocode_72_telnet
 - audiocode_shell_telnet
 - brocade_fastiron_telnet
 - brocade_netiron_telnet
 - calix_b6_telnet
 - centec_os_telnet
 - ciena_saos_telnet
 - cisco_ios_telnet
-- cisco_xr_telnet
 - cisco_s200_telnet
 - cisco_s300_telnet
+- cisco_xr_telnet
 - dell_dnos6_telnet
 - dell_powerconnect_telnet
 - dlink_ds_telnet
-- extreme_telnet
 - extreme_exos_telnet
 - extreme_netiron_telnet
+- extreme_telnet
 - generic_telnet
 - generic_termserver_telnet
-- hp_procurve_telnet
+- genexis_solt33_telnet
 - hp_comware_telnet
-- huawei_telnet
+- hp_procurve_telnet
 - huawei_olt_telnet
+- huawei_telnet
 - ipinfusion_ocnos_telnet
 - juniper_junos_telnet
+- maipu_telnet
 - nokia_sros_telnet
 - oneaccess_oneos_telnet
+- optilink_eolt9702_telnet
 - paloalto_panos_telnet
 - rad_etx_telnet
 - raisecom_telnet
@@ -300,5 +317,6 @@
 - extreme_exos
 - juniper_junos
 - linux
+- mikrotik_routeros
 - nokia_sros
 - ubiquiti_edgerouter

README.md

@@ -48,7 +48,7 @@ Netmiko aims to accomplish both of these operations and to do it across a very b
 
 ## Installation
 
-To install netmiko, simply us pip:
+To install netmiko, simply use pip:
 
 ```
 $ pip install netmiko

_release.sh

@@ -69,7 +69,7 @@ if [ -d "netmiko_packaging" ]; then
     exit 1
 else
     echo "Create virtualenv"
-    /usr/local/bin/python3.9 -m venv netmiko_packaging
+    /usr/local/bin/python3.12 -m venv netmiko_packaging
     echo "Source virtualenv"
     source /home/ktbyers/VENV/netmiko_packaging/bin/activate
     which python
@@ -141,7 +141,7 @@ if [ -d "netmiko_packaging" ]; then
     exit 1
 else
     echo "Create virtualenv"
-    /usr/local/bin/python3.9 -m venv netmiko_packaging
+    /usr/local/bin/python3.12 -m venv netmiko_packaging
     echo "Source virtualenv"
     deactivate
     source /home/ktbyers/VENV/netmiko_packaging/bin/activate