Inappropriate references to ushort type in New-DkimSigningConfig and Rotate-DkimSigningConfig.

Ouverte
  • Quelque chose ne va pas ?
#295 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
powershell
Domaine
backend

Piste de recherche

Find the definitions of New-DkimSigningConfig and Rotate-DkimSigningConfig in the ExchangeOnlineManagement module and inspect their KeySize parameter types. Check how similar parameters are typed elsewhere in the module, then verify that both commands can be called under Windows PowerShell 5.1. Done means neither function fails with a type lookup error.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Prerequisites
  • Write a descriptive title.
  • Make sure you are able to repro it on the latest version
  • Search the existing issues.
Steps to reproduce

According to the documentation, for the ExchangeOnlineManagement module:

"All versions of the module are supported in Windows PowerShell 5.1."

Yet, since 3.5.0, two functions have declared parameters using the [ushort] type, which does not exist in the .NET Framework, causing both functions to fail under Windows PowerShell with the "unable to find type [ushort]" error. The issue still exists in 3.6.0.

This is not an issue under PowerShell (as distinct from Windows PowerShell) where an additional library declares the ushort type (system.private.corelib).

Example from New-DkimSigningConfig showing inappropriate ushort declaration for KeySize parameter:

`function script:New-DkimSigningConfig
{
[CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact='Medium')]
param(

[string]
${AdminDisplayName},

${BodyCanonicalization},

[Parameter(Mandatory=$true, Position=0)]
${DomainName},

[Parameter(Mandatory=$true, Position=1)]
[bool]
${Enabled},

${HeaderCanonicalization},

[ValidateSet('1024','2048')]
[ushort]
${KeySize}
)

`

Expected behavior
That the commands declare the "KeySize" parameter using either [uint16] (if for some reason it must be a 16-bit value) or - in line with the rest of the module's functions - [uint32] (which to my mind would be more consistent).

This would resolve the type exception while maintaining compatibility on Windows PowerShell.
Actual behavior
Under Windows PowerShell, calls to both New-DkimSigningConfig and Rotate-DkimSigningConfig fail immediately (before function entry) on account of the ushort type not existing, as shown in the screenshot.
Error details
Unable to find type [ushort].
At C:\Users\lain.robertson\AppData\Local\Temp\tmpEXO_faj3kift.kut\tmpEXO_faj3kift.kut.psm1:25026 char:5
+     [ushort]
+     ~~~~~~~~
    + CategoryInfo          : InvalidOperation: (ushort:TypeName) [], RuntimeException
    + FullyQualifiedErrorId : TypeNotFound
Environment data
PS D:\Data> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.19041.4894
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.19041.4894
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
Version

3.6.0

Visuals

image

Langage dominant
PowerShell
Étoiles
289
Forks
83
Merge moyen
1 min
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de PowerShell/PowerShellGallery

Toutes les issues de PowerShell/PowerShellGallery

Issues similaires

Plus d'issues Backend & API Design

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.