クロスドメイン ライブラリを使用する SharePoint アドインを作成するCreating SharePoint Add-ins that use the cross-domain library

低信頼承認システムと高信頼承認システムのいずれも SharePoint アドインで使用できないか、アドインが SharePoint リソースへの承認を得る唯一の手段としてふさわしい選択ではないシナリオがいくつかあります。There are some scenarios in which neither the low-trust nor the high-trust authorization systems can be used by a SharePoint Add-in, or they are not a good choice as the only means for the add-in to gain authorization to SharePoint resources. Examples:

例:Examples:

  • SharePoint アドインのリモート コンポーネントがオンプレミスではなく、企業のファイアウォールが SharePoint と ACS のサーバー間通信をブロックしているため、低信頼システムを使用することができない。The remote components of the SharePoint Add-in are not on-premise, but a corporate firewall blocks server-to-server communication between SharePoint and ACS, thereby preventing the use of the low-trust system.

  • SharePoint アドインが、SharePoint でのデータ処理にクライアント側の JavaScript に依存する単一ページの Web アプリケーションとして設計されている。The SharePoint Add-in is designed as a single-page web application that relies on client-side JavaScript for data operations with SharePoint.

  • SharePoint アドインは、主にサーバー間の呼び出しに依存して、SharePoint のデータにアクセスします (また、低信頼システムまたは高信頼システムによって承認されます) が、いくつかの JavaScript 呼び出しによって補足する必要があります。たとえば、グラフィックの負荷が高いページで表示されるデータに小さな更新を行うには、JavaScript を使用することにより、ページ全体の再読み込みなしで行うことができます。The SharePoint Add-in relies mainly on server-to-server calls to access SharePoint data (and is authorized by either the low-trust or high-trust systems), but it needs to be supplemented with some JavaScript calls. For example, a graphics-heavy page can use JavaScript to make minor updates to displayed data without having to reload the entire page.

ただし、セキュリティのために、ブラウザーはあるドメインにホストされている JavaScript が別のドメインのリソースにアクセスすることを許可しないため、リモートの JavaScript が SharePoint のリソースにアクセスするには、特別なテクニックが必要です。However, for security, browsers do not allow JavaScript that is hosted on one domain to access resources on another domain, so a special technique is required to allow the remote JavaScript to access SharePoint resources. The SharePoint cross-domain JavaScript library makes it easy for your remote web application to use the technique. SharePoint クロスドメイン JavaScript ライブラリを使用すると、リモート Web アプリケーションでこのテクニックを簡単に使用できるようになります。The SharePoint cross-domain JavaScript library makes it easy for your remote web application to use the technique.

注意

クロスドメイン ライブラリは、データを逆方向でアクセスできるようにする場合にも使用されます。つまり、SharePoint ページの JavaScript がリモート ドメインのデータにアクセスできるようにします。Note The cross-domain library is also used to allow access to data in the reverse direction; that is, to allow JavaScript on a SharePoint page to access data in a remote domain. See Access remote data from a SharePoint page for more information. 詳細については、「SharePoint ページからのリモート データへのアクセス」を参照してください。For more information, see Access remote data from a SharePoint page.

クロスドメイン ライブラリのアーキテクチャを理解するUnderstand the architecture of the cross-domain library

SharePoint クロスドメイン ライブラリは、すべての SharePoint Web サイトの /_layouts/15/ 仮想フォルダーに配置される SP.RequestExecutor.js ファイルに含まれています。The SharePoint cross-domain library is contained in the file SP.RequestExecutor.js, which is located in the /_layouts/15/ virtual folder of every SharePoint website. このファイルのスクリプトは、ブラウザーのクロスドメイン スクリプトに関する制限を解消するために、既知の安全なテクニックをカプセル化します。iFrame は、iFrame のページが別のドメイン内にある場合でも、window.postMessage() 関数を使用して親ページと通信できます。The SharePoint cross-domain library is contained in the file SP.RequestExecutor.js which is located in the /_layouts/15/ virtual folder of every SharePoint website. The scripts in this file encapsulate a secure well-known technique for overcoming the browser's restriction on cross-domain scripting: An iFrame can communicate with its parent page by means of the window.postMessage() function, even if the page in the iFrame is in a different domain. So data requests and responses are passed over the domain boundary by using calls to . このため、データの要求と応答は、postMessage() への呼び出しを使用することで、ドメインの境界を越えて渡されます。So data requests and responses are passed over the domain boundary by using calls to postMessage().

警告

postMessage() 関数は HTML 5 をサポートするブラウザーでのみ動作するため、クロスドメイン ライブラリを使用する SharePoint アドインは、より古いブラウザーでは動作しません。Caution The postMessage() function works only on browsers that support HTML 5, so SharePoint Add-ins that use the cross-domain library will not work on older browsers.

SharePoint では、クロスドメイン ライブラリはリモート Web アプリケーションのページに読み込まれ、そのページに SharePoint ドメインから特別なプロキシ ページをホストする非表示の iFrame を作成します。For SharePoint, the cross-domain library is loaded on a page of the remote web application where it creates a hidden iFrame that hosts a special proxy page from the SharePoint domain. プロキシ ページはすべての SharePoint Web サイトに既に存在します。The proxy page already exists on every SharePoint website.

ライブラリは、SharePoint の REST API への CRUD 呼び出しを行う際に必要な情報が含まれる JavaScript Object Notation (JSON) オブジェクトの作成のために使用されます。JSON オブジェクトは、postMessage() を使用してプロキシ ページに渡されます。プロキシ ページではライブラリも読み込まれ、JSON オブジェクトは SharePoint への REST 呼び出しとして解析されて再構築されます。プロキシ ページは SharePoint ドメイン内にあるため、ブラウザーは呼び出しを許可します。For SharePoint, the cross-domain library is loaded on a page of the remote web application where it creates a hidden iFrame that hosts a special proxy page from the SharePoint domain. The proxy page already exists on every SharePoint website. The library is used to create a JavaScript Object Notation (JSON) object which contains all the information needed to make a CRUD call to the REST APIs of SharePoint. The JSON object is passed to the proxy page by using postMessage(). On the proxy page, where the library is also loaded, the JSON object is parsed and reconstructed as a REST call to SharePoint. Since the proxy page is in the SharePoint domain, the browser allows the call.

もちろんそれでも、SharePoint アドインのリモート コンポーネントには、SharePoint リソースに対して承認されたアクセス権が必要です。そのためには、次の 2 つの方法があります。Of course, the remote components of the SharePoint Add-in still have to have authorized access to the SharePoint resources. There are two ways to do this:

  • アドイン マニフェストで、アドインのプリンシパルの種類を RemoteWebApplication (プロバイダー向けのホスト型アプリの既定) に設定します。Set the add-in principal type to RemoteWebApplication (the default for provider-hosted apps) in the add-in manifest. アドインが ACS に登録されるとき、その登録にはリモート Web アプリケーションのドメインが含まれます。When the add-in is registered with ACS, the registration includes the domain of the remote web application. サーバー側の低信頼システムの一部であるトークン渡しのフローを全く使用していない (このシナリオでそうであるように) 場合でも、SharePoint は ACS に登録されたドメインを信頼します。SharePoint trusts domains that are registered with ACS, even though it is not, in this scenario, using any of the token passing flows that are part of the server-side low-trust system. アドイン登録の詳細については、「SharePoint アドインを登録する」を参照してください。For detailed information about registering add-ins, see Register SharePoint Add-ins.

  • SharePoint ホスト型アドインでは、アドインのプリンシパルの種類を既定の Internal に設定したままにできます。In a SharePoint-hosted add-in, you can leave the add-in principal type set to its default, which is Internal. Then set the AllowedRemoteHostUrl attribute of the Internal element to the URL of the remote web application, as in the following example. その後、Internal 要素の AllowedRemoteHostUrl 属性を、次の例に示すようにリモート Web アプリケーションの URL に設定します。In a SharePoint-hosted add-in, you can leave the add-in principal type set to its default, which is Internal. Then set the AllowedRemoteHostUrl attribute of the Internal element to the URL of the remote web application, as in the following example.

  <AppPrincipal>
    <Internal AllowedRemoteHostUrl="https://example.com/Home.html" />
  </AppPrincipal>

注意

2 番目のオプション (Internal のアドイン プリンシパル) を使用する場合、JavaScript とクロスドメイン ライブラリのみを使用して、SharePoint にアクセスできます。If you use the second option (an Internal add-in principal), you can use only JavaScript and the cross-domain library to access SharePoint. SharePoint クライアント オブジェクト モデルは、Internal の SharePoint アドインではブロックされるため、クロスドメイン ライブラリと、低信頼システムまたは高信頼システムのいずれかを使用するデュアル承認システムを持つことはできません。Note If you use the second option (an Internal add-in principal), then you can use only JavaScript and the cross-domain library to access SharePoint. The SharePoint client object model is blocked for InternalSharePoint Add-ins, so you cannot have a dual authorization system that uses both the cross-domain library and either the low-trust or high-trust systems.

ライブラリを使用する方法の詳細については、「クロスドメイン ライブラリを使用してアドインから SharePoint のデータにアクセスする」を参照してください。For details on how to use the library, see Access SharePoint data from add-ins using the cross-domain library.

SharePoint ページからリモート データにアクセスするAccess remote data from a SharePoint page

SharePoint クロスドメイン ライブラリは逆方向でも使用できます。つまり、SharePoint ページの JavaScript がライブラリを使用して、アドインのリモート コンポーネントからのデータを取得できます。The SharePoint cross-domain library can also be used in the reverse direction; that is, JavaScript on a SharePoint page can use the library to get data from the remote components of the add-in. そのためには、クロスドメイン アーキテクチャを逆にして、リモート Web アプリケーションでプロキシ ページを作成します。To do this, you reverse the cross-domain architecture: you create a proxy page in the remote web application. ライブラリは、プロキシ ページをホストするために iFrame を作成する SharePoint ページから呼び出されます。The library is called from a SharePoint page where it creates an iFrame to host the proxy page.

この方法でライブラリを使用する方法の詳細については、「SharePoint のクロスドメイン ライブラリのカスタム プロキシ ページを作成する」を参照してください。For details about how to use the library in this way, see Create a custom proxy page for the cross-domain library in SharePoint.

関連項目See also