Sandboxed Solution Validator - Beispiel und Download

Sandboxed Solutions lassen sich, sofern sie nach den vorgegebenen Regeln entwickelt wurden, sehr einfach in einer Microsoft SharePoint Server 2010 Site Collection durch einen Site Collection Administrator installieren und aktivieren. Dabei sind keine Farm-Administratoren, kein STSADM und auch keine Power-Shell Scripts nötig. Ich möchte in diesem Beitrag aber nicht auf die Natur der Sandboxed Solutions eingehen (dies werde ich am nächtsten Mittwoch, 7.4.2010 anlässlich der TechDays in Basel machen), sondern mich auf die Möglichkeit konzentrieren, Sandboxed Solutions aus (Farm-)Administratoren-Sicht zu validieren.

Stellen wir uns folgendes Szenario vor: In einer grossen Firma können Site Collection Administratoren Sandboxed Solutions auf Ihren Team- oder Projekt-Sites installieren um damit die out-of-the-box Funktionalität und damit auch der Geschäftsnutzen von SharePoint 2010 zu erhöhen. Die IT-Abteilung hat dazu zwar ihren Segen erteilt, möchte aber, dass die installierten Sandboxed Solutions vorgängig bei der IT eingereicht werden, so dass sie reviewed, registriert und allenfalls auch anderen zur Verfügung gestellt werden können. Nach der Prüfung signiert die IT-Abeitlung das Sandboxed-Solution SharePoint Projekt mit der IT-Signatur. Oder noch einfacher: Eine Firma möchte nur Sandboxed Solutions installiert haben, welche mit ganz bestimmten Signaturen versehen sind - z.B. nur soclhe von internen Entwicklungsteams.

Dieses Szenario ist ein gutes Beispiel für den Einsatz von Sandboxed Solutions Validatoren, welche durch die Klasse SPSoludionValidator implementiert werden können. Wir erstellen deshalb ein neues (leeres) SharePoint-Projekt in Visual Studio 2010 und fügen ihm eine Klasse hinzu:

[Guid("8C5A5EF6-2FAB-49e9-B98F-B1D6992077D3")]
public class PublicKeyTokenSolutionValidator : SPSolutionValidator
{
    public const string InternalName = "PublicKeyTokenSolutionValidator";
   
    public PublicKeyTokenSolutionValidator() { }

    public PublicKeyTokenSolutionValidator(SPUserCodeService sandboxService) :
        base(InternalName, sandboxService)
    {
        Signature = 100; // Change this number if newer version with changed code is deployed!
    }
}

Wichtig ist, dass wir das GUID-Attributt hinzufügen sowie dass wir einen Konstruktor ohne Parameter für die Serialisierung verwenden. Zudem müssen wir den überladenen Konstruktor der Bais-Klasse implementieren. Die Angabe einer Signatur ist hier ebenfalls zu empfehlen: Wir der Code des Validators einmal geändert oder erweitert können wir über die Signatur diese Veränderung dem SPSolutionManager mitteilen.

SPSolutionValidator hat im Wesentlichen 2 für die Validation interessante Methoden:

public override void ValidateSolution(SPSolutionValidationProperties properties)

public override void ValidateAssembly(SPSolutionValidationProperties properties, SPSolutionFile assembly)

Wichtig zu wissen ist hier, dass die beiden Methoden nacheinander (in der angegebenen Reihenfolge) aufgerufen werden. Dies ist deshalb wichtig, weil in den ValidationProperties die Eigenschaft Valid als false in die erste Methode kommt. Wird die Eigenschaft nicht explizit auf Valid=true gestellt, bricht der SPSolutionValidatorManager ab und es wird eine Fehlermeldung angezeigt. Dies kann sehr verwirrend sein: Ich habe zuerst nur die 2. Methode überschrieben - diese wurde aber nie aufgerufen und es kam immer eine Fehlermeldung! Ich musste explizit die erste Methode ebenfalls überschreiben um Valid=true einzustellen!

Nun aber weiter im Text: Wir möchten sicherstellen, dass die installierte Solution mit einer bestimmten Signatur versehen ist. Hierzu vergleichen wir das Public-Key Token des SPSolutionFile mit den von uns vorgegebenen. In diesem Beispiel ist dies einfache eine Konstante:

protected const string AcceptedPublicKeyToken = "421000e22d61e868";

public override void ValidateSolution(SPSolutionValidationProperties properties)
{
    properties.Valid = true; // Important!
}

public override void ValidateAssembly(SPSolutionValidationProperties properties, SPSolutionFile assembly)
{
    properties.Valid = true;

    if (assembly == null)
        return;

    Assembly solutionAssembly = Assembly.Load(assembly.OpenBinary().ToArray());
    if (!AcceptedPublicKeyToken.Equals(GetAssemblyPublicKeyToken(solutionAssembly), StringComparison.InvariantCultureIgnoreCase))
    {
        properties.Valid = false;
        properties.ValidationErrorMessage = "Assembly is not signed from an allowed authority. Please contact XYZ...";
        properties.ValidationErrorUrl = "/_layouts/TechDays.SandboxedSolutions.Validators/InvalidPublicKeyTokenSolution.aspx";
    }
}

private string GetAssemblyPublicKeyToken(Assembly assembly)
{
    Byte[] pktBytes = assembly.GetName().GetPublicKeyToken();
    return string.Concat(pktBytes.Select(pktByte => pktByte.ToString("x2")).ToArray());
}

In meinem Beispiel verweise ich auf eine Application-Page, welche die Fehlerseite anzeigt. Diese ist im Projekt, welches ich weiter unten zum Download bereitgestellt habe enthalten, für diesen Beitrag aber nicht weiter relevant.

Zuletzt müssen wir den fertigen SPSolutionValidator noch in der SharePoint Farm registrieren. Hierfür habe ich ein neues Farm-Scoped Feature in das SharePoint-Projekt eingefügt und einen Event-Receiver für das Feature hinzugefügt. Und so wird der SPSolutionValidator bei der Feature-Aktivierung und -Deaktivierung (de-)registriert:

[Guid("39869cfb-c812-45e1-be80-e723acf2d0a2")]
public class TechDaysSolutionValidatorsEventReceiver : SPFeatureReceiver
{
    public override void FeatureActivated(SPFeatureReceiverProperties properties)
    {
        SPUserCodeService sandboxService = SPUserCodeService.Local;
        SPSolutionValidator publicKeyTokenSolutionValidator = new PublicKeyTokenSolutionValidator(sandboxService);
        sandboxService.SolutionValidators.Add(publicKeyTokenSolutionValidator);
    }

    foreach (PublicKeyTokenSolutionValidator activePktValidator in


    {
        sandboxService.SolutionValidators.Remove(activePktValidator.ProviderId);
    }
    sandboxService.Update();
}

Nun kann die SharePoint-Solution installiert werden und sobald das Farm-Scoped Feature aktiviert ist werden alle Sandboxed-Solutions zusätzliche auf die Signator der darin enthaltenen Assemblies überprpüft:


Die vollständige SharePoint-Solution (mit Visual Studio 2010 RC1 erstellt) kann hier heruntergeladen werden. .Ich bedanke mich herzlich bei Tobias Zimmergren und seinem ausführlichen Beitrag mit Beispiel, welcher mit die Arbeit sehr erleichtert hat.

Microsoft SharePoint Server 2010 Sandboxed Solutions sind eine enorme Bereicherung! Auch wenn das riesige Potenzial solcher Lösungen sicherlich noch nicht ganz ausgeschüpft ist (z.B. im Bereich der Einschränkungen im Obejtkmodell, dem beschränkten Monitoring und der "erfinderischen" Berechnung der verbrauchten Ressourcen), so eröffnen Sandboxed Solutions Entwicklern, Administratoren und Benutzern gleichermässig völlig neue Perspektiven um Geschäftslösungen in SharePoint einzubringen.

Kommentar

Kommentar hinterlassen Name: Email: Ihre URL: Kommentare: Sicherheitscode eingeben: