Skip to content

Commit

Permalink
Make Federation package generate documentation file. Fix some doc for…
Browse files Browse the repository at this point in the history
…matting bugs
  • Loading branch information
mconnew committed Jul 7, 2023
1 parent a1be0cc commit 9f86105
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<IsShipping>$(Ship_WcfPackages)</IsShipping>
<TargetFramework>net6.0</TargetFramework>
<PackageDescription>Provides the types that allow security communications with SOAP messages using WS-Federation.</PackageDescription>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ public interface IWSTrustChannelContract
/// </summary>
/// <param name="request">The <see cref="WsTrustRequest" /> to send to the STS.</param>
/// <returns>A <see cref="SecurityToken" /> issued by the STS.</returns>
/// <summary>
[OperationContract(Name = "Issue", Action = "*", ReplyAction = "*")]
Task<SecurityToken> IssueAsync(WsTrustRequest request);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ protected virtual Message CreateRequest(WsTrustRequest trustRequest)
/// <summary>
/// Gets the WS-Addressing SOAP action that corresponds to the <see cref="WsTrustRequest"/>.RequestType and <see cref="WsTrustRequest"/>.WsTrustVersion.
/// </summary>
/// <param name="trustRequest">The <see cref="WsTrustRequest"/> to generate the WS-Addressing action.
/// <param name="trustRequest">The <see cref="WsTrustRequest"/> to generate the WS-Addressing action.</param>
/// <returns>The WS-Addressing action to use.</returns>
public static string GetRequestAction(WsTrustRequest trustRequest)
{
Expand Down Expand Up @@ -112,7 +112,7 @@ public static string GetRequestAction(WsTrustRequest trustRequest)
/// <summary>
/// Gets the <see cref="WsSerializationContext"/> to use when serializing the <see cref="WsTrustRequest"/>.
/// </summary>
/// <param name="trustRequest">The <see cref="WsTrustRequest"/> that will be serialized.
/// <param name="trustRequest">The <see cref="WsTrustRequest"/> that will be serialized.</param>
/// <returns>The <see cref="WsSerializationContext"/> for the <see cref="WsTrustRequest"/>.</returns>
private WsSerializationContext GetSerializationContext(WsTrustRequest trustRequest)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ namespace System.ServiceModel.Federation
/// </summary>
internal static class WSTrustUtilities
{
/// <summary>
/// Get a proof token from a WsTrust request/response pair based on section 4.4.3 of the WS-Trust 1.3 spec.
/// How the proof token is retrieved depends on whether the requester or issuer provide key material:
/// Requester | Issuer | Results
Expand All @@ -32,6 +33,8 @@ internal static class WSTrustUtilities
/// </summary>
/// <param name="request">The WS-Trust request (RST).</param>
/// <param name="response">The WS-Trust response (RSTR).</param>
/// <param name="serializationContext">The serialization context.</param>
/// <param name="algorithmSuite">The algorithm suite.</param>
/// <returns>The proof token or null if there is no proof token.</returns>
internal static BinarySecretSecurityToken GetProofToken(WsTrustRequest request, Microsoft.IdentityModel.Protocols.WsTrust.RequestSecurityTokenResponse response, WsSerializationContext serializationContext, SecurityAlgorithmSuite algorithmSuite)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ public WSTrustTokenParameters WSTrustTokenParameters
/// </summary>
/// <returns>a <see cref="SecurityBindingElement"/> for the RelyingParty channel.</returns>
/// <remarks>Creates a new <see cref="TransportBindingElement"/> and adds <see cref="WSTrustTokenParameters"/> to the appropriate EndpointSupportingTokenParameters (Endorsing or Signed).
/// <para>Sets: <see cref="MessageSecurityVersion"/> == <see cref="WSTrustTokenParameters.MessageSecurityVersion"/>.</para></para>
/// <para>Sets: <see cref="IncludeTimestamp"/> == true.</para></remarks>
/// <para>Sets: <see cref="SecurityBindingElement.MessageSecurityVersion"/> == <see cref="WSTrustTokenParameters.MessageSecurityVersion"/>.</para>
/// <para>Sets: <see cref="SecurityBindingElement.IncludeTimestamp"/> == true.</para></remarks>
protected override SecurityBindingElement CreateMessageSecurity()
{
WSTrustTokenParameters.RequireDerivedKeys = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ protected WSTrustChannelClientCredentials(WSTrustChannelClientCredentials other)
/// Crates an instance of <see cref="WSTrustChannelClientCredentials"/> with specifying a <see cref="ClientCredentials"/>
/// </summary>
/// <param name="clientCredentials">The <see cref="SecurityTokenManager"/> from this parameter will be used to
/// create the <see cref="SecurityTokenProvider"/> in the case the <see cref="SecurityTokenParameters"/> in the channel are not a <see cref="WSTrustTokenParameters"/></para></remarks>
/// create the <see cref="SecurityTokenProvider"/> in the case the <see cref="System.ServiceModel.Security.Tokens.SecurityTokenParameters"/> in the channel are not a <see cref="WSTrustTokenParameters"/></param>
public WSTrustChannelClientCredentials(ClientCredentials clientCredentials)
: base(clientCredentials)
{
Expand All @@ -62,7 +62,7 @@ protected override ClientCredentials CloneCore()
/// </summary>
/// <remarks>The <see cref="SecurityTokenManager"/> is responsible to return the <see cref="SecurityTokenProvider"/> to obtain the issued token.
/// <para>If <see cref="ClientCredentials"/> was passed to the constructor, then that <see cref="SecurityTokenManager"/> will be used to
/// create the <see cref="SecurityTokenProvider"/> in the case the <see cref="SecurityTokenParameters"/> in the channel are not a <see cref="WSTrustTokenParameters"/></para></remarks>
/// create the <see cref="SecurityTokenProvider"/> in the case the <see cref="System.ServiceModel.Security.Tokens.SecurityTokenParameters"/> in the channel are not a <see cref="WSTrustTokenParameters"/></para></remarks>
/// <returns>An instance of <see cref="WSTrustChannelSecurityTokenManager" />.</returns>
public override SecurityTokenManager CreateSecurityTokenManager()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ public class WSTrustTokenParameters : IssuedSecurityTokenParameters
private int _issuedTokenRenewalThresholdPercentage = DefaultIssuedTokenRenewalThresholdPercentage;

/// <summary>
/// Instantiates a <see cref="wsTrustTokenParameters"/> that describe the parameters for a WSTrust request.
/// Instantiates a <see cref="WSTrustTokenParameters"/> that describe the parameters for a WSTrust request.
/// </summary>
/// <remarks><see cref="KeyType"/> == <see cref="SecurityKeyType.SymmetricKey"/>.
/// <para><see cref="MessageSecurityVersion"/> == <see cref="MessageSecurityVersion.WSSecurity11WSTrust13WSSecureConversation13WSSecurityPolicy12BasicSecurityProfile10"/></para></remarks>
/// <remarks>
/// <para>Sets: <see cref="IssuedSecurityTokenParameters.KeyType"/> == <see cref="SecurityKeyType.SymmetricKey"/>.</para>
/// <para>Sets: <see cref="IssuedSecurityTokenParameters.DefaultMessageSecurityVersion"/> == <see cref="MessageSecurityVersion.WSSecurity11WSTrust13WSSecureConversation13WSSecurityPolicy12BasicSecurityProfile10"/></para>
/// <para>Sets: <see cref="MessageSecurityVersion"/> == <see cref="MessageSecurityVersion.WSSecurity11WSTrust13WSSecureConversation13WSSecurityPolicy12BasicSecurityProfile10"/></para></remarks>
public WSTrustTokenParameters()
{
KeyType = DefaultSecurityKeyType;
Expand Down

0 comments on commit 9f86105

Please sign in to comment.