GoogleAuthenticator - GitLite

KO | EN

gitlite — search

#javascript #llm #golang #go #rust #linux #nodejs #windows #awesome #kubernetes #vue #ios #mcp #openai

GoogleAuthenticator

(★ 391)

Simple, easy to use server-side two-factor authentication library for .NET that works with Google Authenticator and Authy.

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
- dependabot.yml
- azure-pipeline.yaml
- Base32Encoding.cs
- Google.Authenticator.csproj
- HashType.cs
- QRException.cs
- SetupCode.cs
- TwoFactorAuthenticator.cs
- AuthCodeTest.cs
- GeneratePinTests.cs
- Google.Authenticator.Tests.csproj
- IntervalTests.cs
- QRCodeAndSetupUrlTests.cs
- SecretTypeTests.cs
- SetupCodeTests.cs
- TimeStepTests.cs
- - AssemblyInfo.cs
- Default.aspx
- Default.aspx.cs
- Default.aspx.designer.cs
- Global.asax
- Global.asax.cs
- Google.Authenticator.WebSample.csproj
- Web.config
- Web.Debug.config
- Web.Release.config
- - AssemblyInfo.cs
  - Resources.Designer.cs
  - Resources.resx
  - Settings.Designer.cs
  - Settings.settings
- App.config
- Form1.cs
- Form1.Designer.cs
- Form1.resx
- Google.Authenticator.WinTest.csproj
- Program.cs
- - _ViewImports.cshtml
  - _ViewStart.cshtml
  - Index.cshtml
  - Index.cshtml.cs
- - launchSettings.json
- - favicon.ico
- appsettings.Development.json
- appsettings.json
- GoogleAuthenticator.WebCoreSample.csproj
- Program.cs
.gitignore
Google.Authenticator.sln
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/BrandonPotter/GoogleAuthenticator

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd GoogleAuthenticator

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

cd Google.Authenticator.Tests

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GoogleAuthenticator
Simple, easy to use server-side two-factor authentication library for .NET that works with Google Authenticator

[![build](https://github.com/BrandonPotter/GoogleAuthenticator/actions/workflows/build.yml/badge.svg)](https://github.com/BrandonPotter/GoogleAuthenticator/actions/workflows/build.yml)
[![NuGet Status](https://img.shields.io/nuget/v/GoogleAuthenticator.svg)](https://www.nuget.org/packages/GoogleAuthenticator/)

[`Install-Package GoogleAuthenticator`](https://www.nuget.org/packages/GoogleAuthenticator)

## Usage

*Additional examples at [Google.Authenticator.WinTest](https://github.com/BrandonPotter/GoogleAuthenticator/tree/master/Google.Authenticator.WinTest) and [Google.Authenticator.WebSample](https://github.com/BrandonPotter/GoogleAuthenticator/tree/master/Google.Authenticator.WebSample)*

`key` should be stored by your application for future authentication and shouldn't be regenerated for each request. The process of storing the private key is outside the scope of this library and is the responsibility of the application.

```csharp
using Google.Authenticator;

string key;

TwoFactorAuthenticator tfa = new TwoFactorAuthenticator();
SetupCode setupInfo = tfa.GenerateSetupCode("Test Two Factor", "user@example.com", key, false, 3);

string qrCodeImageUrl = setupInfo.QrCodeSetupImageUrl;
string manualEntrySetupCode = setupInfo.ManualEntryKey;

imgQrCode.ImageUrl = qrCodeImageUrl;
lblManualSetupCode.Text = manualEntrySetupCode;

// verify
TwoFactorAuthenticator tfa = new TwoFactorAuthenticator();
bool result = tfa.ValidateTwoFactorPIN(key, txtCode.Text)
```

## Update history

### 3.3.0

Added support for configuring the "time step". This is basically how often the code changes.
The default used by most authenticator apps is 30 seconds, but some hardware devices use 60 seconds. You can now specify this in the constructor.

### 3.2.0

Added support for HMACSHA256 and HMACSHA512 as per the [RFC spec](https://datatracker.ietf.org/doc/html/rfc6238#section-1.2). In testing it was found that several popular apps (such as Authy and Microsoft Authenticator) may not have support for these algorithms so care should be taken by the developer to ensure compatible apps are used.

### 3.1.1

Fixed an edge case where specifying an interval of 30 seconds to the Validate function would be treated as if you had passed in 0.

### 3.1.0

- Removed .NET 5 and added .NET 7 to test frameworks
- Updated dependencies for test runs
- Support ValidateTwoFactorPIN with iterationOffset as parameter

### 3.0.0

- Removed support for legacy .Net Framework. Lowest supported versions are now netstandard2.0 and .Net 4.6.2.  
- All use of System.Drawing has been removed. In 2.5, only Net 6.0 avoided System.Drawing.
- Linux installations no longer need to ensure `libgdiplus` is installed as it is no longer used.
- Changed from using `EscapeUriString` to `EscapeDataString` to encode the "account title" as the former is [obsolete in .Net 6](https://docs.microsoft.com/en-us/dotnet/fundamentals/syslib-diagnostics/syslib0013). This changes the value in the generated data string from `a@b.com` to `a%40b.com`. We have tested this with Google Authenticator, Lastpass Authenticator and Microsoft Authenticator. All three of them handle it correctly and all three recognise that it is still the same account so this should be safe in most cases.

### 2.5.0

Now runs on .Net 6.0.  
Technically the QR Coder library we rely on still does not fully support .Net 6.0 so it is possible there will be other niggling issues, but for now all tests pass for .Net 6.0 on both Windows and Linux.

## Common Pitfalls

* Old documentation indicated specifying width and height for the QR code, but changes in QR generation now uses pixels per module (QR "pixel") so using a value too high will result in a huge image that can overrun memory allocations
* Don't use the secret key and `ManualEntryKey` interchangeably. `ManualEntryKey` is used to enter into the authenticator app when scanning a QR code is impossible and is derived from the secret key ([discussion example](https://github.com/BrandonPotter/GoogleAuthenticator/issues/54))
* *With versions prior to 3.0 only*, on linux, you need to ensure `libgdiplus` is installed if you want to generate QR Codes. See [https://github.com/codebude/QRCoder/issues/227](https://github.com/codebude/QRCoder/issues/227).