Codemaru.Services.Certificates.X509CertificateMonitorService 클래스 참조

더 자세히 ...

Codemaru.Services.Certificates.X509CertificateMonitorService에 대한 상속 다이어그램 :

Codemaru.Services.Certificates.X509CertificateMonitorService에 대한 협력 다이어그램:

Public 멤버 함수
Task< CertificateStatusInfo >	GetStatusAsync (CertificateMonitorOptions options, CancellationToken cancellationToken)

정적 Private 멤버 함수
static IEnumerable< string >	FindCertificateFiles (CertificateMonitorOptions options)
static bool	IsCertificateCandidate (string path)
static int	GetCertificatePriority (string path)
static ? CertificateStatusInfo	TryReadCertificate (string path, CertificateMonitorOptions options, List< string > readErrors)
static X509Certificate2	LoadCertificate (string path, CertificateMonitorOptions options)
static X509Certificate2	LoadCertificateFromPem (string path)
static bool	IsServerCertificate (X509Certificate2 certificate)
static CertificateStatusInfo	SelectBestCertificate (IReadOnlyCollection< CertificateStatusInfo > candidates)
static int	GetSelectedFilePriority (string? path)
static CertificateHealthState	ResolveState (int remainingDays, CertificateMonitorOptions options)
static string	BuildMessage (CertificateHealthState state, int remainingDays, string certificatePath)
static CertificateStatusInfo	Failure (string? directory, string message)

상세한 설명

파일 시스템의 X509 인증서를 읽어 만료 상태를 계산합니다.

X509CertificateMonitorService.cs 파일의 20 번째 라인에서 정의되었습니다.

멤버 함수 문서화

BuildMessage()

string Codemaru.Services.Certificates.X509CertificateMonitorService.BuildMessage ( CertificateHealthState state, int remainingDays, string certificatePath )

inlinestaticprivate

Message 값을 구성합니다.

매개변수

state	state에 사용할 CertificateHealthState 값입니다.
remainingDays	remaining Days에 사용할 int 값입니다.
certificatePath	certificate Path에 사용할 string 값입니다.

반환값

Build Message 작업에서 생성한 string 결과입니다.

X509CertificateMonitorService.cs 파일의 716 번째 라인에서 정의되었습니다.

    {
        string fileName = Path.GetFileName(certificatePath);
 
        return state switch
        {
            CertificateHealthState.Ok =>
                $"Certificate is valid. Remaining days: {remainingDays}. File: {fileName}",
 
            CertificateHealthState.Warning =>
                $"Certificate renewal should be checked. Remaining days: {remainingDays}. File: {fileName}",
 
            CertificateHealthState.Critical =>
                $"Certificate expires soon. Remaining days: {remainingDays}. File: {fileName}",
 
            CertificateHealthState.Expired =>
                $"Certificate expired. Expired days: {Math.Abs(remainingDays)}. File: {fileName}",
 
            _ =>
                $"Certificate state is unknown. Remaining days: {remainingDays}. File: {fileName}"
        };
    }

다음을 참조함 : Codemaru.Models.Certificates.Critical, Codemaru.Models.Certificates.Expired, Codemaru.Models.Certificates.Ok, Codemaru.Models.Certificates.Warning.

다음에 의해서 참조됨 : TryReadCertificate().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

Failure()

CertificateStatusInfo Codemaru.Services.Certificates.X509CertificateMonitorService.Failure ( string? directory, string message )

inlinestaticprivate

Failure 작업을 수행합니다.

매개변수

directory	directory에 사용할 string? 값입니다.
message	처리할 메시지입니다.

반환값

Failure 작업에서 생성한 CertificateStatusInfo 결과입니다.

X509CertificateMonitorService.cs 파일의 774 번째 라인에서 정의되었습니다.

    {
        return new CertificateStatusInfo
        {
            IsSuccess = false,
            CertificateDirectory = directory ?? string.Empty,
            State = CertificateHealthState.Error,
            Message = message
        };
    }

다음에 의해서 참조됨 : GetStatusAsync().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

FindCertificateFiles()

IEnumerable< string > Codemaru.Services.Certificates.X509CertificateMonitorService.FindCertificateFiles ( CertificateMonitorOptions options )

inlinestaticprivate

Certificate Files 항목을 찾습니다.

매개변수

options

동작을 구성하는 설정입니다.

반환값

Find Certificate Files 작업에서 생성한 IEnumerable<string> 결과입니다.

X509CertificateMonitorService.cs 파일의 147 번째 라인에서 정의되었습니다.

    {
        string[] patterns = options.CertificateFilePatterns is { Length: > 0 }
            ? options.CertificateFilePatterns
            : ["*.pem", "*.cer", "*.crt", "*.pfx", "*.p12"];
 
        IEnumerable<string> files = patterns
            .SelectMany(pattern =>
                Directory.EnumerateFiles(
                    options.CertificateDirectory,
                    pattern,
                    SearchOption.AllDirectories));
 
        return files
            .Where(IsCertificateCandidate)
            .OrderByDescending(GetCertificatePriority)
            .ThenByDescending(File.GetLastWriteTimeUtc);
    }

다음을 참조함 : Codemaru.Options.CertificateMonitorOptions.CertificateDirectory, GetCertificatePriority(), IsCertificateCandidate().

다음에 의해서 참조됨 : GetStatusAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetCertificatePriority()

int Codemaru.Services.Certificates.X509CertificateMonitorService.GetCertificatePriority ( string path )

inlinestaticprivate

Certificate Priority 값을 가져옵니다.

매개변수

path	path에 사용할 string 값입니다.

반환값

Get Certificate Priority 작업에서 생성한 int 결과입니다.

X509CertificateMonitorService.cs 파일의 237 번째 라인에서 정의되었습니다.

    {
        string fileName = Path.GetFileName(path).ToLowerInvariant();
 
        if (fileName.Contains("-crt.pem", StringComparison.OrdinalIgnoreCase))
        {
            return 700;
        }
 
        if (fileName.Contains("fullchain", StringComparison.OrdinalIgnoreCase))
        {
            return 600;
        }
 
        if (fileName.EndsWith(".crt", StringComparison.OrdinalIgnoreCase))
        {
            return 500;
        }
 
        if (fileName.EndsWith(".cer", StringComparison.OrdinalIgnoreCase))
        {
            return 400;
        }
 
        if (fileName.EndsWith(".pfx", StringComparison.OrdinalIgnoreCase) ||
            fileName.EndsWith(".p12", StringComparison.OrdinalIgnoreCase))
        {
            return 300;
        }
 
        if (fileName.EndsWith(".pem", StringComparison.OrdinalIgnoreCase))
        {
            return 100;
        }
 
        return 0;
    }

다음에 의해서 참조됨 : FindCertificateFiles().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetSelectedFilePriority()

int Codemaru.Services.Certificates.X509CertificateMonitorService.GetSelectedFilePriority ( string? path )

inlinestaticprivate

Selected File Priority 값을 가져옵니다.

매개변수

path	path에 사용할 string? 값입니다.

반환값

Get Selected File Priority 작업에서 생성한 int 결과입니다.

X509CertificateMonitorService.cs 파일의 584 번째 라인에서 정의되었습니다.

    {
        if (string.IsNullOrWhiteSpace(path))
        {
            return int.MaxValue;
        }
 
        string fileName = Path.GetFileName(path).ToLowerInvariant();
 
        if (fileName.Contains("-crt.pem", StringComparison.OrdinalIgnoreCase))
        {
            return 0;
        }
 
        if (fileName.Contains("fullchain", StringComparison.OrdinalIgnoreCase))
        {
            return 1;
        }
 
        if (fileName.EndsWith(".crt", StringComparison.OrdinalIgnoreCase))
        {
            return 2;
        }
 
        if (fileName.EndsWith(".cer", StringComparison.OrdinalIgnoreCase))
        {
            return 3;
        }
 
        if (fileName.EndsWith(".pfx", StringComparison.OrdinalIgnoreCase) ||
            fileName.EndsWith(".p12", StringComparison.OrdinalIgnoreCase))
        {
            return 4;
        }
 
        return 10;
    }

다음에 의해서 참조됨 : SelectBestCertificate().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

GetStatusAsync()

Task< CertificateStatusInfo > Codemaru.Services.Certificates.X509CertificateMonitorService.GetStatusAsync ( CertificateMonitorOptions options, CancellationToken cancellationToken )

inline

Status Async 값을 가져옵니다.

매개변수

options	동작을 구성하는 설정입니다.
cancellationToken	취소 요청을 감시하는 토큰입니다.

반환값

Get Status Async 작업에서 생성한 Task<CertificateStatusInfo> 결과입니다.

Codemaru.Services.Certificates.ICertificateMonitorService를 구현.

X509CertificateMonitorService.cs 파일의 54 번째 라인에서 정의되었습니다.

    {
        ArgumentNullException.ThrowIfNull(options);
        cancellationToken.ThrowIfCancellationRequested();
 
        if (string.IsNullOrWhiteSpace(options.CertificateDirectory))
        {
            return Task.FromResult(Failure(options.CertificateDirectory, "Certificate directory is empty."));
        }
 
        if (!Directory.Exists(options.CertificateDirectory))
        {
            return Task.FromResult(Failure(
                options.CertificateDirectory,
                $"Certificate directory not found: {options.CertificateDirectory}"));
        }
 
        try
        {
            string[] files = FindCertificateFiles(options).ToArray();
 
            if (files.Length == 0)
            {
                return Task.FromResult(Failure(
                    options.CertificateDirectory,
                    $"No certificate files were found. Directory: {options.CertificateDirectory}"));
            }
 
            List<string> readErrors = [];
            List<CertificateStatusInfo> candidates = [];
 
            foreach (string file in files)
            {
                cancellationToken.ThrowIfCancellationRequested();
 
                CertificateStatusInfo? status = TryReadCertificate(file, options, readErrors);
                if (status is not null)
                {
                    candidates.Add(status);
                }
            }
 
            if (candidates.Count == 0)
            {
                string errorText = readErrors.Count == 0
                    ? "No detailed read errors were captured."
                    : string.Join(Environment.NewLine, readErrors);
 
                return Task.FromResult(Failure(
                    options.CertificateDirectory,
                    $"Certificate files were found, but none could be loaded.{Environment.NewLine}{errorText}"));
            }
 
            CertificateStatusInfo selected = SelectBestCertificate(candidates);
 
            return Task.FromResult(selected);
        }
        catch (OperationCanceledException)
        {
            throw;
        }
        catch (Exception ex)
        {
            return Task.FromResult(Failure(options.CertificateDirectory, ex.Message));
        }
    }

다음을 참조함 : Codemaru.Options.CertificateMonitorOptions.CertificateDirectory, Failure(), FindCertificateFiles(), SelectBestCertificate(), TryReadCertificate().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

IsCertificateCandidate()

bool Codemaru.Services.Certificates.X509CertificateMonitorService.IsCertificateCandidate ( string path )

inlinestaticprivate

Is Certificate Candidate 조건을 확인합니다.

매개변수

path	path에 사용할 string 값입니다.

반환값

Is Certificate Candidate 조건이 충족되면 true이고, 그렇지 않으면 false입니다.

X509CertificateMonitorService.cs 파일의 190 번째 라인에서 정의되었습니다.

    {
        string fileName = Path.GetFileName(path).ToLowerInvariant();
        string extension = Path.GetExtension(path).ToLowerInvariant();
 
        if (fileName.Contains("key", StringComparison.OrdinalIgnoreCase))
        {
            return false;
        }
 
        if (fileName.Contains("privkey", StringComparison.OrdinalIgnoreCase))
        {
            return false;
        }
 
        if (fileName.Contains("chain-only", StringComparison.OrdinalIgnoreCase))
        {
            return false;
        }
 
        return extension is ".pem" or ".crt" or ".cer" or ".pfx" or ".p12";
    }

다음에 의해서 참조됨 : FindCertificateFiles().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

IsServerCertificate()

bool Codemaru.Services.Certificates.X509CertificateMonitorService.IsServerCertificate ( X509Certificate2 certificate )

inlinestaticprivate

Is Server Certificate 조건을 확인합니다.

매개변수

certificate

certificate에 사용할 X509Certificate2 값입니다.

반환값

Is Server Certificate 조건이 충족되면 true이고, 그렇지 않으면 false입니다.

X509CertificateMonitorService.cs 파일의 496 번째 라인에서 정의되었습니다.

    {
        foreach (X509Extension extension in certificate.Extensions)
        {
            if (extension is X509EnhancedKeyUsageExtension eku)
            {
                foreach (Oid oid in eku.EnhancedKeyUsages)
                {
                    if (oid.Value == "1.3.6.1.5.5.7.3.1")
                    {
                        return true;
                    }
                }
            }
        }
 
        return certificate.Subject.Contains("CN=", StringComparison.OrdinalIgnoreCase);
    }

다음에 의해서 참조됨 : LoadCertificateFromPem().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

LoadCertificate()

X509Certificate2 Codemaru.Services.Certificates.X509CertificateMonitorService.LoadCertificate ( string path, CertificateMonitorOptions options )

inlinestaticprivate

Certificate 데이터를 불러옵니다.

매개변수

path	path에 사용할 string 값입니다.
options	동작을 구성하는 설정입니다.

반환값

Load Certificate 작업에서 생성한 X509Certificate2 결과입니다.

X509CertificateMonitorService.cs 파일의 388 번째 라인에서 정의되었습니다.

    {
        string extension = Path.GetExtension(path).ToLowerInvariant();
 
        if (extension is ".pfx" or ".p12")
        {
            return string.IsNullOrEmpty(options.PfxPassword)
                ? new X509Certificate2(path)
                : new X509Certificate2(path, options.PfxPassword);
        }
 
        if (extension == ".pem")
        {
            return LoadCertificateFromPem(path);
        }
 
        return new X509Certificate2(path);
    }

다음을 참조함 : LoadCertificateFromPem(), Codemaru.Options.CertificateMonitorOptions.PfxPassword.

다음에 의해서 참조됨 : TryReadCertificate().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

LoadCertificateFromPem()

X509Certificate2 Codemaru.Services.Certificates.X509CertificateMonitorService.LoadCertificateFromPem ( string path )

inlinestaticprivate

Certificate From Pem 데이터를 불러옵니다.

매개변수

path	path에 사용할 string 값입니다.

반환값

Load Certificate From Pem 작업에서 생성한 X509Certificate2 결과입니다.

예외

InvalidOperationException

현재 객체 상태에서 Load Certificate From Pem 작업을 수행할 수 없는 경우 발생합니다.

X509CertificateMonitorService.cs 파일의 441 번째 라인에서 정의되었습니다.

    {
        string pem = File.ReadAllText(path);
 
        X509Certificate2Collection collection = new();
        collection.ImportFromPem(pem);
 
        if (collection.Count == 0)
        {
            throw new InvalidOperationException("No certificate block was found in the PEM file.");
        }
 
        X509Certificate2? serverCertificate = collection
            .OfType<X509Certificate2>()
            .Where(IsServerCertificate)
            .OrderByDescending(item => item.NotAfter)
            .FirstOrDefault();
 
        if (serverCertificate is not null)
        {
            return new X509Certificate2(serverCertificate.RawData);
        }
 
        X509Certificate2 first = collection
            .OfType<X509Certificate2>()
            .OrderByDescending(item => item.NotAfter)
            .First();
 
        return new X509Certificate2(first.RawData);
    }

다음을 참조함 : IsServerCertificate().

다음에 의해서 참조됨 : LoadCertificate().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

ResolveState()

CertificateHealthState Codemaru.Services.Certificates.X509CertificateMonitorService.ResolveState ( int remainingDays, CertificateMonitorOptions options )

inlinestaticprivate

Resolve State 작업을 수행합니다.

매개변수

remainingDays	remaining Days에 사용할 int 값입니다.
options	동작을 구성하는 설정입니다.

반환값

Resolve State 작업에서 생성한 CertificateHealthState 결과입니다.

X509CertificateMonitorService.cs 파일의 654 번째 라인에서 정의되었습니다.

    {
        if (remainingDays < 0)
        {
            return CertificateHealthState.Expired;
        }
 
        if (remainingDays < options.CriticalDays)
        {
            return CertificateHealthState.Critical;
        }
 
        if (remainingDays < options.WarningDays)
        {
            return CertificateHealthState.Warning;
        }
 
        return CertificateHealthState.Ok;
    }

다음을 참조함 : Codemaru.Options.CertificateMonitorOptions.CriticalDays, Codemaru.Options.CertificateMonitorOptions.WarningDays.

다음에 의해서 참조됨 : TryReadCertificate().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

SelectBestCertificate()

CertificateStatusInfo Codemaru.Services.Certificates.X509CertificateMonitorService.SelectBestCertificate ( IReadOnlyCollection< CertificateStatusInfo > candidates )

inlinestaticprivate

Select Best Certificate 작업을 수행합니다.

매개변수

candidates

candidates에 사용할 IReadOnlyCollection<CertificateStatusInfo> 값입니다.

반환값

Select Best Certificate 작업에서 생성한 CertificateStatusInfo 결과입니다.

X509CertificateMonitorService.cs 파일의 539 번째 라인에서 정의되었습니다.

    {
        DateTimeOffset now = DateTimeOffset.Now;
 
        CertificateStatusInfo? validCertificate = candidates
            .Where(item => item.NotAfter is not null && item.NotAfter.Value > now)
            .OrderBy(item => GetSelectedFilePriority(item.CertificatePath))
            .ThenBy(item => item.NotAfter)
            .FirstOrDefault();
 
        if (validCertificate is not null)
        {
            return validCertificate;
        }
 
        return candidates
            .OrderByDescending(item => item.NotAfter ?? DateTimeOffset.MinValue)
            .First();
    }

다음을 참조함 : GetSelectedFilePriority().

다음에 의해서 참조됨 : GetStatusAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

TryReadCertificate()

? CertificateStatusInfo Codemaru.Services.Certificates.X509CertificateMonitorService.TryReadCertificate ( string path, CertificateMonitorOptions options, List< string > readErrors )

inlinestaticprivate

Read Certificate 작업을 시도하고 성공 여부를 반환합니다.

매개변수

path	path에 사용할 string 값입니다.
options	동작을 구성하는 설정입니다.
readErrors	read Errors에 사용할 List<string> 값입니다.

반환값

Try Read Certificate 작업에서 생성한 CertificateStatusInfo? 결과입니다.

X509CertificateMonitorService.cs 파일의 315 번째 라인에서 정의되었습니다.

    {
        try
        {
            using X509Certificate2 certificate = LoadCertificate(path, options);
 
            if (string.IsNullOrWhiteSpace(certificate.Subject))
            {
                readErrors.Add($"{Path.GetFileName(path)}: Certificate subject is empty.");
                return null;
            }
 
            DateTimeOffset notAfter = new(certificate.NotAfter);
            DateTimeOffset notBefore = new(certificate.NotBefore);
            int remainingDays = (int)Math.Floor((notAfter - DateTimeOffset.Now).TotalDays);
            CertificateHealthState state = ResolveState(remainingDays, options);
 
            return new CertificateStatusInfo
            {
                IsSuccess = true,
                CertificateDirectory = options.CertificateDirectory,
                CertificatePath = path,
                Subject = certificate.Subject,
                Issuer = certificate.Issuer,
                NotBefore = notBefore,
                NotAfter = notAfter,
                RemainingDays = remainingDays,
                State = state,
                Message = BuildMessage(state, remainingDays, path)
            };
        }
        catch (Exception ex)
        {
            readErrors.Add($"{Path.GetFileName(path)}: {ex.GetType().Name} - {ex.Message}");
            return null;
        }
    }

다음을 참조함 : BuildMessage(), Codemaru.Options.CertificateMonitorOptions.CertificateDirectory, LoadCertificate(), ResolveState().

다음에 의해서 참조됨 : GetStatusAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

이 함수를 호출하는 함수들에 대한 그래프입니다.:

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• X509CertificateMonitorService.cs