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

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

[범례]

Public 멤버 함수
	WinAcmeService (IProcessRunner processRunner)
async Task< WinAcmeTaskInfo >	GetRenewalTaskAsync (CancellationToken cancellationToken)
Task< ProcessExecutionResult >	RunRenewAsync (CertificateMonitorOptions options, bool force, CancellationToken cancellationToken)

Private 멤버 함수
async Task< WinAcmeTaskInfo >	GetTaskDetailAsync (string taskName, string taskPath, string state, CancellationToken cancellationToken)
Task< ProcessExecutionResult >	RunPowerShellAsync (string command, TimeSpan timeout, int maxOutputChars, CancellationToken cancellationToken)

정적 Private 멤버 함수
static string	EscapePowerShellSingleQuotedString (string value)
static string	NormalizeTaskPath (string taskPath)
static string	GetString (JsonElement root, string propertyName)

Private 속성
readonly IProcessRunner	_processRunner

정적 Private 속성
const string	PowerShellPath = @"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe"

상세한 설명

win-acme 갱신 작업 상태 조회와 갱신 명령 실행을 담당합니다.

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

생성자 & 소멸자 문서화

◆ WinAcmeService()

Codemaru.Services.Certificates.WinAcmeService.WinAcmeService ( IProcessRunner processRunner )

inline

WinAcmeService 클래스의 새 인스턴스를 초기화합니다.

매개변수

processRunner 외부 프로세스 실행 서비스입니다.

예외

ArgumentNullException 필수 입력 인자 중 하나가 null인 경우 발생합니다.

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

    {
        _processRunner = processRunner ?? throw new ArgumentNullException(nameof(processRunner));
    }

다음을 참조함 : _processRunner.

멤버 함수 문서화

◆ EscapePowerShellSingleQuotedString()

string Codemaru.Services.Certificates.WinAcmeService.EscapePowerShellSingleQuotedString ( string value )

inlinestaticprivate

Escape Power Shell Single Quoted String 작업을 수행합니다.

매개변수

value 적용할 값입니다.

반환값: Escape Power Shell Single Quoted String 작업에서 생성한 string 결과입니다.

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

    {
        return value.Replace("'", "''", StringComparison.Ordinal);
    }

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

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

◆ GetRenewalTaskAsync()

async Task< WinAcmeTaskInfo > Codemaru.Services.Certificates.WinAcmeService.GetRenewalTaskAsync ( CancellationToken cancellationToken )

inline

Renewal Task Async 값을 가져옵니다.

매개변수

cancellationToken 취소 요청을 감시하는 토큰입니다.

반환값: Get Renewal Task Async 작업에서 생성한 Task<WinAcmeTaskInfo> 결과입니다.

Codemaru.Services.Certificates.IWinAcmeService를 구현.

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

    {
        string command = """
$task = Get-ScheduledTask -ErrorAction SilentlyContinue |
    Where-Object {
        $_.TaskName -like '*win-acme*' -or
        $_.TaskPath -like '*win-acme*' -or
        $_.Description -like '*win-acme*'
    } |
    Select-Object -First 1 TaskName, TaskPath, State
 
if ($null -eq $task) {
    return
}
 
$task | ConvertTo-Json -Compress
""";
 
        ProcessExecutionResult result = await RunPowerShellAsync(
            command,
            TimeSpan.FromSeconds(20),
            4000,
            cancellationToken).ConfigureAwait(false);
 
        if (!result.IsSuccess)
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = false,
                Message = $"Failed to query scheduled task. {result.Message} {result.Error}".Trim()
            };
        }
 
        if (string.IsNullOrWhiteSpace(result.Output))
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = false,
                Message = "win-acme scheduled task was not found."
            };
        }
 
        try
        {
            using JsonDocument document = JsonDocument.Parse(result.Output);
            JsonElement root = document.RootElement;
            string taskName = GetString(root, "TaskName");
            string taskPath = NormalizeTaskPath(GetString(root, "TaskPath"));
            string state = GetString(root, "State");
 
            return await GetTaskDetailAsync(taskName, taskPath, state, cancellationToken).ConfigureAwait(false);
        }
        catch (Exception ex)
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = false,
                Message = $"Failed to parse scheduled task information. {ex.Message}"
            };
        }
    }

다음을 참조함 : GetString(), GetTaskDetailAsync(), Codemaru.Models.Certificates.ProcessExecutionResult.IsSuccess, NormalizeTaskPath(), Codemaru.Models.Certificates.ProcessExecutionResult.Output, RunPowerShellAsync().

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

◆ GetString()

string Codemaru.Services.Certificates.WinAcmeService.GetString	(	JsonElement	root,
		string	propertyName )

inlinestaticprivate

String 값을 가져옵니다.

매개변수

root	root에 사용할 `JsonElement` 값입니다.
propertyName	property Name에 사용할 `string` 값입니다.

반환값: Get String 작업에서 생성한 string 결과입니다.

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

    {
        return root.TryGetProperty(propertyName, out JsonElement element)
            ? element.ToString()
            : string.Empty;
    }

다음에 의해서 참조됨 : GetRenewalTaskAsync(), GetTaskDetailAsync().

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

◆ GetTaskDetailAsync()

async Task< WinAcmeTaskInfo > Codemaru.Services.Certificates.WinAcmeService.GetTaskDetailAsync	(	string	taskName,
		string	taskPath,
		string	state,
		CancellationToken	cancellationToken )

inlineprivate

Task Detail Async 값을 가져옵니다.

매개변수

taskName	task Name에 사용할 `string` 값입니다.
taskPath	task Path에 사용할 `string` 값입니다.
state	state에 사용할 `string` 값입니다.
cancellationToken	취소 요청을 감시하는 토큰입니다.

반환값: Get Task Detail Async 작업에서 생성한 Task<WinAcmeTaskInfo> 결과입니다.

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

    {
        if (string.IsNullOrWhiteSpace(taskName))
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = false,
                State = state,
                Message = "win-acme scheduled task name is empty."
            };
        }
 
        string escapedTaskName = EscapePowerShellSingleQuotedString(taskName);
        string escapedTaskPath = EscapePowerShellSingleQuotedString(taskPath);
        string command = $$"""
$t = Get-ScheduledTask -TaskName '{{escapedTaskName}}' -TaskPath '{{escapedTaskPath}}' -ErrorAction SilentlyContinue
if ($null -eq $t) {
    return
}
 
$i = $t | Get-ScheduledTaskInfo -ErrorAction SilentlyContinue
 
$lastRun = '-'
$nextRun = '-'
$lastResult = '-'
 
if ($null -ne $i) {
    if ($i.LastRunTime -ne [DateTime]::MinValue) {
        $lastRun = $i.LastRunTime.ToString('yyyy-MM-dd HH:mm:ss')
    }
 
    if ($i.NextRunTime -ne [DateTime]::MinValue) {
        $nextRun = $i.NextRunTime.ToString('yyyy-MM-dd HH:mm:ss')
    }
 
    $lastResult = $i.LastTaskResult.ToString()
}
 
[PSCustomObject]@{
    TaskName=$t.TaskName
    TaskPath=$t.TaskPath
    State=$t.State.ToString()
    LastRunTime=$lastRun
    NextRunTime=$nextRun
    LastTaskResult=$lastResult
} | ConvertTo-Json -Compress
""";
 
        ProcessExecutionResult result = await RunPowerShellAsync(
            command,
            TimeSpan.FromSeconds(20),
            4000,
            cancellationToken).ConfigureAwait(false);
 
        if (!result.IsSuccess || string.IsNullOrWhiteSpace(result.Output))
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = true,
                TaskName = taskName,
                TaskPath = taskPath,
                State = state,
                Message = "win-acme scheduled task was found, but detailed task info could not be loaded."
            };
        }
 
        try
        {
            using JsonDocument document = JsonDocument.Parse(result.Output);
            JsonElement root = document.RootElement;
 
            return new WinAcmeTaskInfo
            {
                IsSuccess = true,
                TaskName = GetString(root, "TaskName"),
                TaskPath = NormalizeTaskPath(GetString(root, "TaskPath")),
                State = GetString(root, "State"),
                LastRunTime = GetString(root, "LastRunTime"),
                NextRunTime = GetString(root, "NextRunTime"),
                LastTaskResult = GetString(root, "LastTaskResult"),
                Message = "win-acme scheduled task is registered."
            };
        }
        catch (Exception ex)
        {
            return new WinAcmeTaskInfo
            {
                IsSuccess = false,
                TaskName = taskName,
                TaskPath = taskPath,
                State = state,
                Message = $"Failed to parse task detail. {ex.Message}"
            };
        }
    }

다음을 참조함 : EscapePowerShellSingleQuotedString(), GetString(), Codemaru.Models.Certificates.ProcessExecutionResult.IsSuccess, NormalizeTaskPath(), Codemaru.Models.Certificates.ProcessExecutionResult.Output, RunPowerShellAsync().

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

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

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

◆ NormalizeTaskPath()

string Codemaru.Services.Certificates.WinAcmeService.NormalizeTaskPath ( string taskPath )

inlinestaticprivate

Normalize Task Path 작업을 수행합니다.

매개변수

taskPath task Path에 사용할 string 값입니다.

반환값: Normalize Task Path 작업에서 생성한 string 결과입니다.

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

    {
        if (string.IsNullOrWhiteSpace(taskPath))
        {
            return @"\";
        }
 
        return taskPath;
    }

다음에 의해서 참조됨 : GetRenewalTaskAsync(), GetTaskDetailAsync().

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

◆ RunPowerShellAsync()

Task< ProcessExecutionResult > Codemaru.Services.Certificates.WinAcmeService.RunPowerShellAsync	(	string	command,
		TimeSpan	timeout,
		int	maxOutputChars,
		CancellationToken	cancellationToken )

inlineprivate

Run Power Shell Async 작업을 수행합니다.

매개변수

command	command에 사용할 `string` 값입니다.
timeout	timeout에 사용할 `TimeSpan` 값입니다.
maxOutputChars	max Output Chars에 사용할 `int` 값입니다.
cancellationToken	취소 요청을 감시하는 토큰입니다.

반환값: Run Power Shell Async 작업에서 생성한 Task<ProcessExecutionResult> 결과입니다.

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

    {
        string encodedCommand = Convert.ToBase64String(Encoding.Unicode.GetBytes(command));
        return _processRunner.RunAsync(
            PowerShellPath,
            $"-NoProfile -ExecutionPolicy Bypass -EncodedCommand {encodedCommand}",
            null,
            timeout,
            maxOutputChars,
            cancellationToken);
    }

다음을 참조함 : _processRunner, PowerShellPath.

다음에 의해서 참조됨 : GetRenewalTaskAsync(), GetTaskDetailAsync().

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

◆ RunRenewAsync()

Task< ProcessExecutionResult > Codemaru.Services.Certificates.WinAcmeService.RunRenewAsync	(	CertificateMonitorOptions	options,
		bool	force,
		CancellationToken	cancellationToken )

inline

Run Renew Async 작업을 수행합니다.

매개변수

options	동작을 구성하는 설정입니다.
force	force에 사용할 `bool` 값입니다.
cancellationToken	취소 요청을 감시하는 토큰입니다.

반환값: Run Renew Async 작업에서 생성한 Task<ProcessExecutionResult> 결과입니다.

Codemaru.Services.Certificates.IWinAcmeService를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(options);
 
        string arguments = force ? "--renew --force" : "--renew";
        return _processRunner.RunAsync(
            options.WacsPath,
            arguments,
            Path.GetDirectoryName(options.WacsPath),
            TimeSpan.FromMinutes(5),
            options.MaxCommandOutputChars,
            cancellationToken);
    }

다음을 참조함 : _processRunner, Codemaru.Options.CertificateMonitorOptions.MaxCommandOutputChars, Codemaru.Options.CertificateMonitorOptions.WacsPath.

멤버 데이터 문서화

◆ _processRunner

readonly IProcessRunner Codemaru.Services.Certificates.WinAcmeService._processRunner

private

process Runner 값을 보관합니다.

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

다음에 의해서 참조됨 : RunPowerShellAsync(), RunRenewAsync(), WinAcmeService().

◆ PowerShellPath

const string Codemaru.Services.Certificates.WinAcmeService.PowerShellPath = @"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe"

staticprivate

Power Shell Path 값을 보관합니다.

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

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

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

WinAcmeService.cs

Public 멤버 함수

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

정적 Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ WinAcmeService()

멤버 함수 문서화

◆ EscapePowerShellSingleQuotedString()

◆ GetRenewalTaskAsync()

◆ GetString()

◆ GetTaskDetailAsync()

◆ NormalizeTaskPath()

◆ RunPowerShellAsync()

◆ RunRenewAsync()

멤버 데이터 문서화

◆ _processRunner

◆ PowerShellPath