.NET Core での gRPC のトラブルシューティングTroubleshoot gRPC on .NET Core

作成者: James Newton-KingBy James Newton-King

このドキュメントでは、.NET で gRPC アプリを開発する際によく発生する問題について説明します。This document discusses commonly encountered problems when developing gRPC apps on .NET.

クライアントとサービスの SSL/TLS 構成が一致しないMismatch between client and service SSL/TLS configuration

GRPC テンプレートとサンプルでは、トランスポート層セキュリティ (TLS) を使用して、既定で gRPC サービスをセキュリティ保護しています。The gRPC template and samples use Transport Layer Security (TLS) to secure gRPC services by default. gRPC クライアントは、セキュリティ保護された gRPC サービスを正常に呼び出すために、セキュリティ保護された接続を使用する必要があります。gRPC clients need to use a secure connection to call secured gRPC services successfully.

アプリの起動時に書き込まれたログで、ASP.NET Core gRPC サービスが TLS を使用していることを確認できます。You can verify the ASP.NET Core gRPC service is using TLS in the logs written on app start. サービスは、HTTPS エンドポイントでリッスンします。The service will be listening on an HTTPS endpoint:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development

.NET Core クライアントは、サーバー アドレスで https を使用して、セキュリティ保護された接続で呼び出しを行う必要があります。The .NET Core client must use https in the server address to make calls with a secured connection:

static async Task Main(string[] args)
{
    // The port number(5001) must match the port of the gRPC server.
    var channel = GrpcChannel.ForAddress("https://localhost:5001");
    var client = new Greet.GreeterClient(channel);
}

すべての gRPC クライアント実装で TLS をサポートしています。All gRPC client implementations support TLS. 他の言語の gRPC クライアントでは、通常、SslCredentials によって構成されたチャネルが必要です。gRPC clients from other languages typically require the channel configured with SslCredentials. SslCredentials は、クライアントで使用する証明書を指定し、安全でない資格情報の代わりにそれが使用される必要があります。SslCredentials specifies the certificate that the client will use, and it must be used instead of insecure credentials. さまざまな gRPC クライアント実装で TLS を使用するように構成する例については、gRPC 認証に関するページを参照してください。For examples of configuring the different gRPC client implementations to use TLS, see gRPC Authentication.

信頼されていないか無効な証明書で gRPC サービスを呼び出すCall a gRPC service with an untrusted/invalid certificate

.NET gRPC クライアントでは、サービスに信頼された証明書が必要です。The .NET gRPC client requires the service to have a trusted certificate. 信頼された証明書を使用せずに gRPC サービスを呼び出すと、次のエラーメッセージが返されます。The following error message is returned when calling a gRPC service without a trusted certificate:

ハンドルされていない例外です。Unhandled exception. System.Net.Http.HttpRequestException:SSL 接続を確立できませんでした。内部例外を参照してください。System.Net.Http.HttpRequestException: The SSL connection could not be established, see inner exception. ---> System.Security.Authentication.AuthenticationException:検証プロシージャによると、リモート証明書は無効です。---> System.Security.Authentication.AuthenticationException: The remote certificate is invalid according to the validation procedure.

このエラーは、アプリをローカルでテストしていて、ASP.NET Core HTTPS 開発証明書が信頼されていない場合に表示されることがあります。You may see this error if you are testing your app locally and the ASP.NET Core HTTPS development certificate is not trusted. この問題を解決する手順については、「Windows と macOS で ASP.NET Core HTTPS 開発証明書を信頼します」を参照してください。For instructions to fix this issue, see Trust the ASP.NET Core HTTPS development certificate on Windows and macOS.

別のコンピューターで gRPC サービスを呼び出しており、その証明書を信頼できない場合、gRPC クライアントが無効な証明書を無視するように構成できます。If you are calling a gRPC service on another machine and are unable to trust the certificate then the gRPC client can be configured to ignore the invalid certificate. 次のコードでは HttpClientHandler.ServerCertificateCustomValidationCallback を使用して、信頼された証明書を使用しない呼び出しを許可しています。The following code uses HttpClientHandler.ServerCertificateCustomValidationCallback to allow calls without a trusted certificate:

var httpHandler = new HttpClientHandler();
// Return `true` to allow certificates that are untrusted/invalid
httpHandler.ServerCertificateCustomValidationCallback = 
    HttpClientHandler.DangerousAcceptAnyServerCertificateValidator;

var channel = GrpcChannel.ForAddress("https://localhost:5001",
    new GrpcChannelOptions { HttpHandler = httpHandler });
var client = new Greet.GreeterClient(channel);

警告

信頼されていない証明書は、アプリの開発時にのみ使用してください。Untrusted certificates should only be used during app development. 実稼働アプリでは、常に有効な証明書を使用する必要があります。Production apps should always use valid certificates.

.NET Core クライアントで安全でない gRPC サービスを呼び出すCall insecure gRPC services with .NET Core client

.NET Core クライアントで安全でない gRPC サービスを呼び出すには、追加の構成が必要です。Additional configuration is required to call insecure gRPC services with the .NET Core client. gRPC クライアントは、System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport スイッチを true に設定し、サーバー アドレスで http を使用する必要があります。The gRPC client must set the System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport switch to true and use http in the server address:

// This switch must be set before creating the GrpcChannel/HttpClient.
AppContext.SetSwitch(
    "System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);

// The port number(5000) must match the port of the gRPC server.
var channel = GrpcChannel.ForAddress("http://localhost:5000");
var client = new Greet.GreeterClient(channel);

MacOS で ASP.NET Core gRPC アプリを起動できないUnable to start ASP.NET Core gRPC app on macOS

Kestrel では、macOS や Windows 7 などの古い Windows バージョンでの TLS による HTTP/2 がサポートされていません。Kestrel doesn't support HTTP/2 with TLS on macOS and older Windows versions such as Windows 7. ASP.NET Core gRPC テンプレートとサンプルでは、既定で TLS を使用しています。The ASP.NET Core gRPC template and samples use TLS by default. gRPC サーバーを起動しようとすると、次のエラー メッセージが表示されます。You'll see the following error message when you attempt to start the gRPC server:

Unable to bind to https://localhost:5001 on the IPv4 loopback interface:'HTTP/2 over TLS is not supported on macOS due to missing ALPN support.'. (IPv4 ループバック インターフェイスで https://localhost:5001 にバインドできません。'HTTP/2 over TLS は ALPN サポートがないため、macOS でサポートされていません。')Unable to bind to https://localhost:5001 on the IPv4 loopback interface: 'HTTP/2 over TLS is not supported on macOS due to missing ALPN support.'.

この問題を回避するには、TLS を使用せずに HTTP/2 を使用するように Kestrel と gRPC クライアントを構成します。To work around this issue, configure Kestrel and the gRPC client to use HTTP/2 without TLS. これは開発時にのみ実行してください。You should only do this during development. TLS を使用しないと、gRPC メッセージが暗号化されずに送信されます。Not using TLS will result in gRPC messages being sent without encryption.

Kestrel では、Program.cs で TLS を使用せずに HTTP/2 エンドポイントを構成する必要があります。Kestrel must configure an HTTP/2 endpoint without TLS in Program.cs:

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.ConfigureKestrel(options =>
            {
                // Setup a HTTP/2 endpoint without TLS.
                options.ListenLocalhost(5000, o => o.Protocols = 
                    HttpProtocols.Http2);
            });
            webBuilder.UseStartup<Startup>();
        });

HTTP/2 エンドポイントが TLS を使用せずに構成されている場合、エンドポイントの ListenOptions.ProtocolHttpProtocols.Http2 に設定する必要があります。When an HTTP/2 endpoint is configured without TLS, the endpoint's ListenOptions.Protocols must be set to HttpProtocols.Http2. HTTP/2 のネゴシエートに TLS が必要であるため、HttpProtocols.Http1AndHttp2 は使用できません。HttpProtocols.Http1AndHttp2 can't be used because TLS is required to negotiate HTTP/2. TLS を使用しない場合、エンドポイントへのすべての接続が既定で HTTP/1.1 に設定され、gRPC の呼び出しが失敗します。Without TLS, all connections to the endpoint default to HTTP/1.1, and gRPC calls fail.

GRPC クライアントでも、TLS を使用しないように構成する必要があります。The gRPC client must also be configured to not use TLS. 詳細については、「.NET Core クライアントで安全でない gRPC サービスを呼び出す」を参照してください。For more information, see Call insecure gRPC services with .NET Core client.

警告

TLS を使用しない HTTP/2 は、アプリの開発時にのみ使用してください。HTTP/2 without TLS should only be used during app development. 実稼働アプリでは、常にトランスポート セキュリティを使用する必要があります。Production apps should always use transport security. 詳細については、 gRPC for ASP.NET Core のセキュリティの考慮事項 に関するページを参照してください。For more information, see Security considerations in gRPC for ASP.NET Core.

gRPC C# アセットが .proto ファイルから生成されたコードでないgRPC C# assets are not code generated from .proto files

具象クライアントとサービス基本クラスの gRPC コード生成には、protobuf ファイルとツールをプロジェクトから参照する必要があります。gRPC code generation of concrete clients and service base classes requires protobuf files and tooling to be referenced from a project. 次のものを含める必要があります。You must include:

gRPC C# アセットの生成の詳細については、「C# を使用した gRPC サービス」を参照してください。For more information on generating gRPC C# assets, see C# を使用した gRPC サービス.

gRPC サービスをホストしている ASP.NET Core Web アプリには、生成されたサービス基本クラスのみが必要です。An ASP.NET Core web app hosting gRPC services only needs the service base class generated:

<ItemGroup>
  <Protobuf Include="Protos\greet.proto" GrpcServices="Server" />
</ItemGroup>

gRPC 呼び出しを行う gRPC クライアント アプリでは、生成された具象クライアントのみが必要です。A gRPC client app making gRPC calls only needs the concrete client generated:

<ItemGroup>
  <Protobuf Include="Protos\greet.proto" GrpcServices="Client" />
</ItemGroup>

WPF プロジェクトで .proto ファイルから gRPC C# アセットを生成できないWPF projects unable to generate gRPC C# assets from .proto files

WPF プロジェクトには、gRPC コードの生成が正常に機能しなくなる既知の問題があります。WPF projects have a known issue that prevents gRPC code generation from working correctly. WPF プロジェクトで Grpc.Tools.proto ファイルを参照して生成された gRPC 型は、使用すると、コンパイル エラーが発生します。Any gRPC types generated in a WPF project by referencing Grpc.Tools and .proto files will create compilation errors when used:

エラー CS0246:型または名前空間の名前 'tMyGrpcServices' が見つかりませんでした (using ディレクティブまたはアセンブリ参照が指定されていることを確認してください)error CS0246: The type or namespace name 'MyGrpcServices' could not be found (are you missing a using directive or an assembly reference?)

この問題は次の方法で回避できます。You can workaround this issue by:

  1. 新しい .NET Core クラス ライブラリ プロジェクトを作成します。Create a new .NET Core class library project.
  2. 新しいプロジェクトで、参照を追加して、 *.proto ファイルからの C# コード生成を有効にします。In the new project, add references to enable C# code generation from *.proto files:
    • Grpc.Tools パッケージにパッケージ参照を追加します。Add a package reference to Grpc.Tools package.
    • <Protobuf> 項目グループに *.proto ファイルを追加します。Add *.proto files to the <Protobuf> item group.
  3. WPF アプリケーションで、新しいプロジェクトに参照を追加します。In the WPF application, add a reference to the new project.

WPF アプリケーションでは、新しいクラス ライブラリ プロジェクトから、gRPC によって生成された型を使用できます。The WPF application can use the gRPC generated types from the new class library project.

警告

現在、ASP.NET Core gRPC は Azure App Service または IIS 上でサポートされていません。ASP.NET Core gRPC is not currently supported on Azure App Service or IIS. Http.Sys の HTTP/2 実装では、gRPC が依存する HTTP 応答の末尾のヘッダーがサポートされていません。The HTTP/2 implementation of Http.Sys does not support HTTP response trailing headers which gRPC relies on. 詳細については、次を参照してください。この GitHub の問題します。For more information, see this GitHub issue.