Articles on: Advanced Topics

Instructions for Generating and Sharing a Public Key for SFTP Access

Key Requirements


Your SSH key must meet the following requirements:


  • Key Type: RSA
  • Key Length: Minimum 2048 bits (4096 recommended)
  • Private Key Format: PKCS#1 (RSA)


The private key should begin and end with:


-----BEGIN RSA PRIVATE KEY-----


...


-----END RSA PRIVATE KEY-----



Option 1: Generate Keys on Windows (PuTTYgen)


Step 1: Open PuTTYgen


Download and launch PuTTYgen (puttygen.exe).


Step 2: Configure the Key


Select:


  • Key Type: RSA (SSH-2 RSA)
  • Number of Bits: 2048


Step 3: Generate the Key


  1. Click Generate.
  2. Move your mouse randomly within the blank area until key generation completes.


Step 4: Save the Public Key


  1. Copy the text from "Public key for pasting into OpenSSH authorized_keys file".
  2. Paste it into Notepad or another text editor.
  3. Save the file as:


metalocator-YYYYMMDD.pub


Step 5: Save the Private Key


  1. Click Conversions > Export OpenSSH.
  2. Store the file in a secure location.


Step 6: Send the Public Key to MetaLocator


Provide only the .pub file to the MetaLocator support team via email or your support ticket.


Important


  • Never share your private key.
  • Store your private key securely and keep a backup.



Option 2: Generate Keys on Mac or Linux


Step 1: Open Terminal


macOS


Applications → Utilities → Terminal


Linux


Open your preferred terminal application.


Step 2: Generate the Key Pair


Run the following command:


ssh-keygen -t rsa -b 4096 -m PEM -C "your_username" -f metalocator-YYYYMMDD


Example:


ssh-keygen -t rsa -b 4096 -m PEM -C "jane.doe@example.com" -f metalocator-20260601


Step 3: Follow the Prompts


  1. Press Enter to accept the file location.
  2. Choose a passphrase:


  • Optional but recommended for additional security.
  • Press Enter to leave it blank.


Step 4: Locate Your Key Files


After generation, you will have:


File

Purpose

metalocator-YYYYMMDD

Private Key

metalocator-YYYYMMDD.pub

Public Key


Example:


  • metalocator-20260601 (private key)
  • metalocator-20260601.pub (public key)


Step 5: Send the Public Key to MetaLocator


Send only the .pub file to the MetaLocator support team via email or your support ticket.



Verify Your Key (Optional)


Verify the Public Key


Run:


ssh-keygen -lf metalocator-YYYYMMDD.pub


Verify the Private Key Format


Open the private key file in a text editor and confirm it begins and ends with:


-----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY-----



Using Your Private Key in MetaLocator


When configuring SFTP access in MetaLocator:


  1. Open your private key file.
  2. Copy the entire contents exactly as shown.
  3. Paste the key into the MetaLocator SFTP configuration.


Important:


  • Do not edit the key.
  • Do not remove line breaks.
  • Do not alter the BEGIN or END lines.



Security Best Practices


✅ Share only the public key (.pub file)


✅ Store your private key securely


✅ Keep a backup of your private key


❌ Never share your private key with anyone


❌ Do not modify the contents of your key files

Updated on: 12/11/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!