Proper Weg zum verstecken API Schlüssel in Git

Question

In meinem C# -Projekt haben APIKeys.cs Datei, die Const Strings mit API-Schlüssel haben. Ich möchte, dass diese Zeichenfolgen im Git-Server leer sind, aber tatsächliche API-Schlüssel in meinem lokalen Computer haben. So können Leute, die Projekt ziehen, es ohne Problem kompilieren und noch mein lokaler Computer wird API-Schlüssel in der gleichen Datei haben.

Wenn ich versuche, APIKeys.cs Datei mit leeren Zeichenfolgen zu laden, dann kann ich nicht lokale Datei mit API-Schlüssel haben, weil, wenn ich versuche, es zu schieben, wird leere APIKeys.cs-Datei zu überschreiben. Auch ich kann diese Datei nicht ignorieren, da sie die leere Datei APIKeys.cs vom Git-Server entfernt.

Also was ist der beste automatisierte Ansatz für dieses Problem, der eine Klassendatei mit leeren Strings im Server erlaubt, so dass das Projekt kompilierbar ist, wenn Leute es ziehen und eine echte Klassendatei im lokalen Computer haben?

Answer 1

Ich dachte, jetzt eine andere Lösung, die nicht perfekt ist, aber immer noch gut genug für mich, Beispiel:

APIKeys.cs Datei:

public static partial class APIKeys 
{ 
    public static readonly string ImgurClientID = ""; 
    public static readonly string ImgurClientSecret = ""; 
    public static readonly string GoogleClientID = ""; 
    public static readonly string GoogleClientSecret = ""; 
    public static readonly string PastebinKey = ""; 
    ... 
} 

APIKeysLocal.cs Datei:

public static partial class APIKeys 
{ 
    static APIKeys() 
    { 
     ImgurClientID = "1234567890"; 
     ImgurClientSecret = "1234567890"; 
     GoogleClientID = "1234567890"; 
     GoogleClientSecret = "1234567890"; 
     PastebinKey = "1234567890"; 
     ... 
    } 
} 

Ignorieren APIKeysLocal.cs Datei in Git und Leute, die diese Datei nicht haben, können trotzdem ein Projekt kompilieren, wenn sie diese Datei aus der Lösung exp entfernen lorer.

auch erstelle ich automatisch leer APIKeysLocal.cs Datei, wenn es nicht bereits Projekt mit existiert Ereignis vor bauen:

cd $(ProjectDir)APIKeys\ 

if not exist APIKeysLocal.cs (
    type nul > APIKeysLocal.cs 
) 

Auf diese Weise Benutzer etwas tun müssen, nicht in der Lage sein Projekt zu kompilieren.

Answer 2

Akzeptieren Sie, dass Sie unverschlüsselte private Schlüssel in einem öffentlichen Bereich nicht verbergen können.

Sie können die Schlüssel in ein privates Leerzeichen verschieben und dann auf dieses private Leerzeichen aus dem Code verweisen.

Ihr privater Bereich könnte Umgebungsvariablen oder die Windows-Registrierung sein, sollte es etwas außerhalb des Quellcodes Ihrer App sein.

Ein anderer Ansatz besteht darin, eine neue Konfigurationsdatei (z. B. keys.config) speziell zum Speichern privater Schlüssel zu erstellen und diese Datei dann aus der Quellcodeverwaltung auszuschließen.

Das heißt, Sie Ihre privaten Schlüssel nicht teilen, aber es bedeutet auch, dass Sie (vielleicht in readme.md) dokumentieren müssen, dass die Benutzer ihre eigenen keys.config neu erstellen benötigen. Noch besser (danke @Joey) ist eine Beispiel-Konfigurationsdatei (keys.sample.config) in die Lösung aufzunehmen, die zeigt, was benötigt wird.

Here is an example

Answer 3

Sie haben zwei Möglichkeiten bekommen:

1. Git Sagen Sie Änderungen an APIKeys.cs auf dem lokalen Computer zu ignorieren:

   git update-index --skip-worktree APIKeys.cs 
   

   lokale Änderungen Dies führt dazu, nicht zu bekommen engagiert sein. Wenn Sie jemals tun Änderungen an der Datei festschreiben wollen, müssen Sie dies mit dem --no-skip-worktree Flag rückgängig machen.

2. Benennen Sie die Datei APIKeys.cs um so etwas wie APIKeys.template.cs, die leeren Zeichenketten enthalten, die Sie teilen möchten. Bewahren Sie diese Datei in Ihrem Repository auf. Kopieren Sie diese Datei in APIKeys.cs. Fügen Sie APIKeys.cs zu Ihrem .gitignore hinzu. Fügen Sie Anweisungen hinzu, um die Vorlagendatei zu kopieren und mit lokalen Einstellungen zu ändern.

   git mv APIKeys.cs APIKeys.template.cs 
   $EDITOR APIKeys.template.cs 
   git commit 
   cat APIKeys.cs >> .gitignore 
   cp APIKeys.template.cs APIKeys.cs 
   

Answer 4

Ist das nicht sehr ähnlich dem Problem, eine Build-Nummer in Ihrer Komponente der Injektion? Die Art, wie ich das mache, ist ein Pre-Build-Schritt, der basierend auf einer Umgebungsvariablen eine Datei namens AssemblyVersionInfo.cs generiert. Sie könnten dasselbe mit Ihren API Keys machen.

In der Pre-Build-Schritt für die Komponente, die in den API-Schlüssel erstellt setzen etwas wie folgt aus: -

if not defined API_KEY set API_KEY=DEFAULT_KEY 
echo public class ApiKeys>"$(SolutionDir)src\ApiKeys.cs" 
echo {>>"$(SolutionDir)src\ApiKeys.cs" 
echo public const string Key="%API_KEY%";>>"$(SolutionDir)src\ApiKeys.cs" 
echo }>>"$(SolutionDir)src\ApiKeys.cs" 

Dann setzen Sie entweder ein Benutzer oder Systemumgebungsvariable auf dem lokalen Computer mit der realen Schlüssel drin.

setx API_KEY THE_REAL_KEY

Um zu vermeiden, Git wollen die Datei einzuspielen, nur um es zu dem .gitignore hinzuzufügen.